diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..5f1eaee --- /dev/null +++ b/.travis.yml @@ -0,0 +1,48 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: xenial +language: python +python: + - "3.6" + +cache: + pip: true + +# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true", +# or remove the env block entirely and remove the condition in the +# deploy block. +env: + - DEPLOY_PYPI="false" + +deploy: + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + # TODO: Use 'travis encrypt --com -r adafruit/' to generate + # the encrypted password for adafruit-travis. Paste result below. + - provider: pypi + user: adafruit-travis + password: + secure: #-- PASTE ENCRYPTED PASSWORD HERE --# + on: + tags: true + condition: $DEPLOY_PYPI = "true" + +install: + - pip install -r requirements.txt + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 + +script: + - pylint adafruit_minimqtt.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-minimqtt --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community moderators. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE index 5739aaa..d4fbf1d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -MIT License +The MIT License (MIT) -Copyright (c) 2019 Adafruit Industries +Copyright (c) 2019 Brent Rubell for Adafruit Industries Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md deleted file mode 100644 index 650a9ea..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_MiniMQTT -MQTT for CircuitPython diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f07d654 --- /dev/null +++ b/README.rst @@ -0,0 +1,116 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-minimqtt/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/minimqtt/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MiniMQTT.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MiniMQTT + :alt: Build Status + +MQTT Client library for CircuitPython. + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +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 +===================== +.. note:: This library is not available on PyPI yet. Install documentation is included + as a standard element. Stay tuned for PyPI availability! + +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 .env + source .env/bin/activate + pip3 install adafruit-circuitpython-minimqtt + +Usage Example +============= + +Please check the `examples folder `_ +for usage examples for this library. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-minimqtt --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_minimqtt.py b/adafruit_minimqtt.py new file mode 100644 index 0000000..5959dab --- /dev/null +++ b/adafruit_minimqtt.py @@ -0,0 +1,706 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Brent Rubell for Adafruit Industries +# +# Original Work Copyright (c) 2016 Paul Sokolovsky, uMQTT +# Modified Work Copyright (c) 2019 Bradley Beach, esp32spi_mqtt +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_minimqtt` +================================================================================ + +MQTT Library for CircuitPython. + +* Author(s): Brent Rubell + +Implementation Notes +-------------------- + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +""" +import struct +import time +from random import randint +import microcontroller +from micropython import const +import adafruit_logging as logging + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT.git" + +# Client-specific variables +MQTT_MSG_MAX_SZ = const(268435455) +MQTT_MSG_SZ_LIM = const(10000000) +MQTT_TOPIC_LENGTH_LIMIT = const(65535) +MQTT_TCP_PORT = const(1883) +MQTT_TLS_PORT = const(8883) +TCP_MODE = const(0) +TLS_MODE = const(2) + +# MQTT Commands +MQTT_PINGREQ = b'\xc0\0' +MQTT_PINGRESP = const(0xd0) +MQTT_SUB = b'\x82' +MQTT_UNSUB = b'\xA2' +MQTT_PUB = bytearray(b'\x30\0') +MQTT_CON = bytearray(b'\x10\0\0') +# Variable CONNECT header [MQTT 3.1.2] +MQTT_CON_HEADER = bytearray(b"\x04MQTT\x04\x02\0\0") +MQTT_DISCONNECT = b'\xe0\0' + +CONNACK_ERRORS = {const(0x01) : 'Connection Refused - Incorrect Protocol Version', + const(0x02) : 'Connection Refused - ID Rejected', + const(0x03) : 'Connection Refused - Server unavailable', + const(0x04) : 'Connection Refused - Incorrect username/password', + const(0x05) : 'Connection Refused - Unauthorized'} + +class MMQTTException(Exception): + """MiniMQTT Exception class.""" + # pylint: disable=unnecessary-pass + #pass + +class MQTT: + """MQTT Client for CircuitPython + :param socket: Socket object for provided network interface + :param str broker: MQTT Broker URL or IP Address. + :param int port: Optional port definition, defaults to 8883. + :param str username: Username for broker authentication. + :param str password: Password for broker authentication. + :param network_manager: NetworkManager object, such as WiFiManager from ESPSPI_WiFiManager. + :param str client_id: Optional client identifier, defaults to a unique, generated string. + :param bool is_ssl: Sets a secure or insecure connection with the broker. + :param bool log: Attaches a logger to the MQTT client, defaults to logging level INFO. + """ + # pylint: disable=too-many-arguments,too-many-instance-attributes, not-callable, invalid-name, no-member + def __init__(self, socket, broker, port=None, username=None, + password=None, network_manager=None, client_id=None, is_ssl=True, log=False): + # network management + self._socket = socket + network_manager_type = str(type(network_manager)) + if 'ESPSPI_WiFiManager' in network_manager_type: + self._wifi = network_manager + else: + raise TypeError("This library requires a NetworkManager object.") + # broker + try: # set broker IP + self.broker = self._wifi.esp.unpretty_ip(broker) + except ValueError: # set broker URL + self.broker = broker + # port/ssl + self.port = MQTT_TCP_PORT + if is_ssl: + self.port = MQTT_TLS_PORT + if port is not None: + self.port = port + # session identifiers + self._user = username + # [MQTT-3.1.3.5] + self._pass = password + if self._pass is not None and len(password.encode('utf-8')) > MQTT_TOPIC_LENGTH_LIMIT: + raise MMQTTException('Password length is too large.') + if client_id is not None: + # user-defined client_id MAY allow client_id's > 23 bytes or + # non-alpha-numeric characters + self._client_id = client_id + else: + # assign a unique client_id + self._client_id = 'cpy{0}{1}'.format(microcontroller.cpu.uid[randint(0, 15)], + randint(0, 9)) + # generated client_id's enforce spec.'s length rules + if len(self._client_id) > 23 or not self._client_id: + raise ValueError('MQTT Client ID must be between 1 and 23 bytes') + self._logger = None + if log is True: + self._logger = logging.getLogger('log') + self._logger.setLevel(logging.INFO) + self._sock = None + self._is_connected = False + self._msg_size_lim = MQTT_MSG_SZ_LIM + self.packet_id = 0 + self._keep_alive = 0 + self._pid = 0 + self._user_data = None + self._subscribed_topics = [] + # Server callbacks + self.on_message = None + self.on_connect = None + self.on_disconnect = None + self.on_publish = None + self.on_subscribe = None + self.on_unsubscribe = None + self.last_will() + + def __enter__(self): + return self + + def __exit__(self, exception_type, exception_value, traceback): + self.deinit() + + def deinit(self): + """De-initializes the MQTT client and disconnects from + the mqtt broker. + """ + self.disconnect() + + def last_will(self, topic=None, message=None, qos=0, retain=False): + """Sets the last will and testament properties. MUST be called before connect(). + :param str topic: MQTT Broker topic. + :param str message: Last will disconnection message. + :param int qos: Quality of Service level. + :param bool retain: Specifies if the message is to be retained when it is published. + """ + if self._is_connected: + raise MMQTTException('Last Will should be defined before connect() is called.') + if qos < 0 or qos > 2: + raise MMQTTException("Invalid QoS level, must be between 0 and 2.") + if self._logger is not None: + self._logger.debug('Setting last will properties') + self._lw_qos = qos + self._lw_topic = topic + self._lw_msg = message + self._lw_retain = retain + + def reconnect(self, retries=30, resub_topics=True): + """Attempts to reconnect to the MQTT broker. + :param int retries: Amount of retries before resetting the network interface. + :param bool resub_topics: Resubscribe to previously subscribed topics. + """ + retries = 0 + while not self._is_connected: + if self._logger is not None: + self._logger.debug('Attempting to reconnect to broker') + try: + self.connect() + if self._logger is not None: + self._logger.debug('Reconnected to broker') + if resub_topics: + if self._logger is not None: + self._logger.debug('Attempting to resubscribe to prv. subscribed topics.') + while self._subscribed_topics: + feed = self._subscribed_topics.pop() + self.subscribe(feed) + except OSError as e: + if self._logger is not None: + self._logger.debug('Lost connection, reconnecting and resubscribing...', e) + retries += 1 + if retries >= 30: + retries = 0 + time.sleep(1) + continue + + # pylint: disable=too-many-branches, too-many-statements + def connect(self, clean_session=True): + """Initiates connection with the MQTT Broker. + :param bool clean_session: Establishes a persistent session. + """ + self._set_interface() + if self._logger is not None: + self._logger.debug('Creating new socket') + self._sock = self._socket.socket() + self._sock.settimeout(10) + if self.port == 8883: + try: + if self._logger is not None: + self._logger.debug('Attempting to establish secure MQTT connection...') + self._sock.connect((self.broker, self.port), TLS_MODE) + except RuntimeError: + raise MMQTTException("Invalid broker address defined.") + else: + if isinstance(self.broker, str): + addr = self._socket.getaddrinfo(self.broker, self.port)[0][-1] + else: + addr = (self.broker, self.port) + try: + if self._logger is not None: + self._logger.debug('Attempting to establish insecure MQTT connection...') + #self._sock.connect((self.broker, self.port), TCP_MODE) + self._sock.connect(addr, TCP_MODE) + except RuntimeError as e: + raise MMQTTException("Invalid broker address defined.", e) + premsg = MQTT_CON + msg = MQTT_CON_HEADER + msg[6] = clean_session << 1 + sz = 12 + len(self._client_id) + if self._user is not None: + sz += 2 + len(self._user) + 2 + len(self._pass) + msg[6] |= 0xC0 + if self._keep_alive: + assert self._keep_alive < MQTT_TOPIC_LENGTH_LIMIT + msg[7] |= self._keep_alive >> 8 + msg[8] |= self._keep_alive & 0x00FF + if self._lw_topic: + sz += 2 + len(self._lw_topic) + 2 + len(self._lw_msg) + msg[6] |= 0x4 | (self._lw_qos & 0x1) << 3 | (self._lw_qos & 0x2) << 3 + msg[6] |= self._lw_retain << 5 + i = 1 + while sz > 0x7f: + premsg[i] = (sz & 0x7f) | 0x80 + sz >>= 7 + i += 1 + premsg[i] = sz + if self._logger is not None: + self._logger.debug('Sending CONNECT packet to broker') + self._sock.write(premsg) + self._sock.write(msg) + # [MQTT-3.1.3-4] + self._send_str(self._client_id) + if self._lw_topic: + # [MQTT-3.1.3-11] + self._send_str(self._lw_topic) + self._send_str(self._lw_msg) + if self._user is None: + self._user = None + else: + self._send_str(self._user) + self._send_str(self._pass) + if self._logger is not None: + self._logger.debug('Receiving CONNACK packet from broker') + while True: + op = self._wait_for_msg() + if op == 32: + rc = self._sock.read(3) + assert rc[0] == 0x02 + if rc[2] != 0x00: + raise MMQTTException(CONNACK_ERRORS[rc[3]]) + self._is_connected = True + result = rc[0] & 1 + if self.on_connect is not None: + self.on_connect(self, self._user_data, result, rc[2]) + return result + + def disconnect(self): + """Disconnects the MiniMQTT client from the MQTT broker. + """ + self.is_connected() + if self._logger is not None: + self._logger.debug('Sending DISCONNECT packet to broker') + self._sock.write(MQTT_DISCONNECT) + if self._logger is not None: + self._logger.debug('Closing socket') + self._sock.close() + self._is_connected = False + self._subscribed_topics = None + if self.on_disconnect is not None: + self.on_disconnect(self, self._user_data, 0) + + def ping(self): + """Pings the MQTT Broker to confirm if the broker is alive or if + there is an active network connection. + """ + self.is_connected() + if self._logger is not None: + self._logger.debug('Sending PINGREQ') + self._sock.write(MQTT_PINGREQ) + if self._logger is not None: + self._logger.debug('Checking PINGRESP') + while True: + op = self._wait_for_msg(0.5) + if op == 208: + ping_resp = self._sock.read(2) + if ping_resp[0] != 0x00: + raise MMQTTException('PINGRESP not returned from broker.') + return + + # pylint: disable=too-many-branches, too-many-statements + def publish(self, topic, msg, retain=False, qos=0): + """Publishes a message to a topic provided. + :param str topic: Unique topic identifier. + :param str msg: Data to send to the broker. + :param int msg: Data to send to the broker. + :param float msg: Data to send to the broker. + :param bool retain: Whether the message is saved by the broker. + :param int qos: Quality of Service level for the message. + + Example of sending an integer, 3, to the broker on topic 'piVal'. + .. code-block:: python + + mqtt_client.publish('topics/piVal', 3) + + Example of sending a float, 3.14, to the broker on topic 'piVal'. + .. code-block:: python + + mqtt_client.publish('topics/piVal', 3.14) + + Example of sending a string, 'threepointonefour', to the broker on topic piVal. + .. code-block:: python + + mqtt_client.publish('topics/piVal', 'threepointonefour') + + """ + self.is_connected() + self._check_topic(topic) + if '+' in topic or '#' in topic: + raise MMQTTException('Publish topic can not contain wildcards.') + # check msg/qos kwargs + if msg is None: + raise MMQTTException('Message can not be None.') + elif isinstance(msg, (int, float)): + msg = str(msg).encode('ascii') + elif isinstance(msg, str): + msg = str(msg).encode('utf-8') + else: + raise MMQTTException('Invalid message data type.') + if len(msg) > MQTT_MSG_MAX_SZ: + raise MMQTTException('Message size larger than %db.'%MQTT_MSG_MAX_SZ) + self._check_qos(qos) + pkt = MQTT_PUB + pkt[0] |= qos << 1 | retain + sz = 2 + len(topic) + len(msg) + if qos > 0: + sz += 2 + assert sz < 2097152 + i = 1 + while sz > 0x7f: + pkt[i] = (sz & 0x7f) | 0x80 + sz >>= 7 + i += 1 + pkt[i] = sz + if self._logger is not None: + self._logger.debug('Sending PUBLISH\nTopic: {0}\nMsg: {1}\ + \nQoS: {2}\nRetain? {3}'.format(topic, msg, qos, retain)) + self._sock.write(pkt) + self._send_str(topic) + if qos == 0: + if self.on_publish is not None: + self.on_publish(self, self._user_data, topic, self._pid) + if qos > 0: + self._pid += 1 + pid = self._pid + struct.pack_into("!H", pkt, 0, pid) + self._sock.write(pkt) + if self.on_publish is not None: + self.on_publish(self, self._user_data, topic, pid) + if self._logger is not None: + self._logger.debug('Sending PUBACK') + self._sock.write(msg) + if qos == 1: + while True: + op = self._wait_for_msg() + if op == 0x40: + sz = self._sock.read(1) + assert sz == b"\x02" + rcv_pid = self._sock.read(2) + rcv_pid = rcv_pid[0] << 0x08 | rcv_pid[1] + if pid == rcv_pid: + if self.on_publish is not None: + self.on_publish(self, self._user_data, topic, rcv_pid) + return + elif qos == 2: + assert 0 + if self.on_publish is not None: + self.on_publish(self, self._user_data, topic, rcv_pid) + + def subscribe(self, topic, qos=0): + """Subscribes to a topic on the MQTT Broker. + This method can subscribe to one topics or multiple topics. + :param str topic: Unique MQTT topic identifier. + :param int qos: Quality of Service level for the topic, defaults to zero. + :param tuple topic: Tuple containing topic identifier strings and qos level integers. + :param list topic: List of tuples containing topic identifier strings and qos. + + Example of subscribing a topic string. + .. code-block:: python + + mqtt_client.subscribe('topics/ledState') + + Example of subscribing to a topic and setting the qos level to 1. + .. code-block:: python + + mqtt_client.subscribe('topics/ledState', 1) + + Example of subscribing to topic string and setting qos level to 1, as a tuple. + .. code-block:: python + + mqtt_client.subscribe(('topics/ledState', 1)) + + Example of subscribing to multiple topics with different qos levels. + .. code-block:: python + + mqtt_client.subscribe([('topics/ledState', 1), ('topics/servoAngle', 0)]) + + """ + self.is_connected() + topics = None + if isinstance(topic, tuple): + topic, qos = topic + self._check_topic(topic) + self._check_qos(qos) + if isinstance(topic, str): + self._check_topic(topic) + self._check_qos(qos) + topics = [(topic, qos)] + if isinstance(topic, list): + topics = [] + for t, q in topic: + self._check_qos(q) + self._check_topic(t) + topics.append((t, q)) + # Assemble packet + packet_length = 2 + (2 * len(topics)) + (1 * len(topics)) + packet_length += sum(len(topic) for topic, qos in topics) + packet_length_byte = packet_length.to_bytes(1, 'big') + self._pid += 1 + packet_id_bytes = self._pid.to_bytes(2, 'big') + # Packet with variable and fixed headers + packet = MQTT_SUB + packet_length_byte + packet_id_bytes + # attaching topic and QOS level to the packet + for t, q in topics: + topic_size = len(t).to_bytes(2, 'big') + qos_byte = q.to_bytes(1, 'big') + packet += topic_size + t + qos_byte + if self._logger is not None: + for t, q in topics: + self._logger.debug('SUBSCRIBING to topic {0} with QoS {1}'.format(t, q)) + self._sock.write(packet) + while True: + op = self._wait_for_msg() + if op == 0x90: + rc = self._sock.read(4) + assert rc[1] == packet[2] and rc[2] == packet[3] + if rc[3] == 0x80: + raise MMQTTException('SUBACK Failure!') + for t, q in topics: + if self.on_subscribe is not None: + self.on_subscribe(self, self._user_data, t, q) + self._subscribed_topics.append(t) + return + + def unsubscribe(self, topic): + """Unsubscribes from a MQTT topic. + :param str topic: Unique MQTT topic identifier. + :param list topic: List of tuples containing topic identifier strings. + + Example of unsubscribing from a topic string. + .. code-block:: python + + mqtt_client.unsubscribe('topics/ledState') + + Example of unsubscribing from multiple topics. + .. code-block:: python + + mqtt_client.unsubscribe([('topics/ledState'), ('topics/servoAngle')]) + + """ + topics = None + if isinstance(topic, str): + self._check_topic(topic) + topics = [(topic)] + if isinstance(topic, list): + topics = [] + for t in topic: + self._check_topic(t) + topics.append((t)) + for t in topics: + if t not in self._subscribed_topics: + raise MMQTTException('Topic must be subscribed to before attempting unsubscribe.') + # Assemble packet + packet_length = 2 + (2 * len(topics)) + packet_length += sum(len(topic) for topic in topics) + packet_length_byte = packet_length.to_bytes(1, 'big') + self._pid += 1 + packet_id_bytes = self._pid.to_bytes(2, 'big') + packet = MQTT_UNSUB + packet_length_byte + packet_id_bytes + for t in topics: + topic_size = len(t).to_bytes(2, 'big') + packet += topic_size + t + if self._logger is not None: + for t in topics: + self._logger.debug('UNSUBSCRIBING from topic {0}.'.format(t)) + self._sock.write(packet) + if self._logger is not None: + self._logger.debug('Waiting for UNSUBACK...') + while True: + op = self._wait_for_msg() + if op == 176: + return_code = self._sock.read(3) + assert return_code[0] == 0x02 + # [MQTT-3.32] + assert return_code[1] == packet_id_bytes[0] and return_code[2] == packet_id_bytes[1] + for t in topics: + if self.on_unsubscribe is not None: + self.on_unsubscribe(self, self._user_data, t, self._pid) + self._subscribed_topics.remove(t) + return + + def loop_forever(self): + """Starts a blocking message loop. Use this + method if you want to run a program forever. + Network reconnection is handled within this call. + Your code will not execute anything below this call. + """ + run = True + while run: + if self._is_connected: + self._wait_for_msg(0.0) + else: + if self._logger is not None: + self._logger.debug('Lost connection, reconnecting and resubscribing...') + self.reconnect(resub_topics=True) + if self._logger is not None: + self._logger.debug('Connection restored, continuing to loop forever...') + + def loop(self): + """Non-blocking message loop. Use this method to + check incoming subscription messages. Does not handle + network reconnection like loop_forever - reconnection must + be handled within your code. + """ + self._sock.settimeout(0.1) + return self._wait_for_msg() + + def _wait_for_msg(self, timeout=30): + """Reads and processes network events. + Returns response code if successful. + """ + res = self._sock.read(1) + self._sock.settimeout(timeout) + if res in [None, b""]: + return None + if res == MQTT_PINGRESP: + sz = self._sock.read(1)[0] + assert sz == 0 + return None + if res[0] & 0xf0 != 0x30: + return res[0] + sz = self._recv_len() + topic_len = self._sock.read(2) + topic_len = (topic_len[0] << 8) | topic_len[1] + topic = self._sock.read(topic_len) + topic = str(topic, 'utf-8') + sz -= topic_len + 2 + if res[0] & 0x06: + pid = self._sock.read(2) + pid = pid[0] << 0x08 | pid[1] + sz -= 0x02 + msg = self._sock.read(sz) + if self.on_message is not None: + self.on_message(self, topic, str(msg, 'utf-8')) + if res[0] & 0x06 == 0x02: + pkt = bytearray(b"\x40\x02\0\0") + struct.pack_into("!H", pkt, 2, pid) + self._sock.write(pkt) + elif res[0] & 6 == 4: + assert 0 + return res[0] + + def _recv_len(self): + n = 0 + sh = 0 + while True: + b = self._sock.read(1)[0] + n |= (b & 0x7f) << sh + if not b & 0x80: + return n + sh += 7 + + def _send_str(self, string): + """Packs and encodes a string to a socket. + :param str string: String to write to the socket. + """ + self._sock.write(struct.pack("!H", len(string))) + if isinstance(string, str): + self._sock.write(str.encode(string, 'utf-8')) + else: + self._sock.write(string) + + @staticmethod + def _check_topic(topic): + """Checks if topic provided is a valid mqtt topic. + :param str topic: Topic identifier + """ + if topic is None: + raise MMQTTException('Topic may not be NoneType') + # [MQTT-4.7.3-1] + elif not topic: + raise MMQTTException('Topic may not be empty.') + # [MQTT-4.7.3-3] + elif len(topic.encode('utf-8')) > MQTT_TOPIC_LENGTH_LIMIT: + raise MMQTTException('Topic length is too large.') + + @staticmethod + def _check_qos(qos_level): + """Validates the quality of service level. + :param int qos_level: Desired QoS level. + """ + if isinstance(qos_level, int): + if qos_level < 0 or qos_level > 2: + raise MMQTTException('QoS must be between 1 and 2.') + else: + raise MMQTTException('QoS must be an integer.') + + def _set_interface(self): + """Sets a desired network hardware interface. + The network hardware must be set in init + prior to calling this method. + """ + if self._wifi: + self._socket.set_interface(self._wifi.esp) + else: + raise TypeError('Network Manager Required.') + + def is_connected(self): + """Returns MQTT client session status as True if connected, raises + a MMQTTException if False. + """ + if self._sock is None or self._is_connected is False: + raise MMQTTException("MiniMQTT is not connected.") + return self._is_connected + + @property + def mqtt_msg(self): + """Returns maximum MQTT payload and topic size.""" + return self._msg_size_lim, MQTT_TOPIC_LENGTH_LIMIT + + @mqtt_msg.setter + def mqtt_msg(self, msg_size): + """Sets the maximum MQTT message payload size. + :param int msg_size: Maximum MQTT payload size. + """ + if msg_size < MQTT_MSG_MAX_SZ: + self._msg_size_lim = msg_size + + # Logging + def attach_logger(self, logger_name='log'): + """Initializes and attaches a logger to the MQTTClient. + :param str logger_name: Name of the logger instance + """ + self._logger = logging.getLogger(logger_name) + self._logger.setLevel(logging.INFO) + + def set_logger_level(self, log_level): + """Sets the level of the logger, if defined during init. + :param string log_level: Level of logging to output to the REPL. + """ + if self._logger is None: + raise MMQTTException('No logger attached - did you create it during initialization?') + if log_level == 'DEBUG': + self._logger.setLevel(logging.DEBUG) + elif log_level == 'INFO': + self._logger.setLevel(logging.INFO) + elif log_level == 'WARNING': + self._logger.setLevel(logging.WARNING) + elif log_level == 'ERROR': + self._logger.setLevel(logging.CRITICIAL) + else: + raise MMQTTException('Incorrect logging level provided!') diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..7349deb --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_minimqtt + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..0fd26d6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,159 @@ +# -*- coding: utf-8 -*- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] + +# Uncomment the below if you use native CircuitPython modules such as +# digitalio, micropython and busio. List the modules you use. Without it, the +# autodoc module docs will fail to generate with a warning. +autodoc_mock_imports = ["micropython", "microcontroller", "random", "adafruit_logging"] + + +intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Adafruit MiniMQTT Library' +copyright = u'2019 Brent Rubell' +author = u'Brent Rubell' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] + except: + html_theme = 'default' + html_theme_path = ['.'] +else: + html_theme_path = ['.'] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = '_static/favicon.ico' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AdafruitMinimqttLibrarydoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'AdafruitMiniMQTTLibrary.tex', u'AdafruitMiniMQTT Library Documentation', + author, 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'AdafruitMiniMQTTlibrary', u'Adafruit MiniMQTT Library Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'AdafruitMiniMQTTLibrary', u'Adafruit MiniMQTT Library Documentation', + author, 'AdafruitMiniMQTTLibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..847e6bb --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/minimqtt_simpletest.py + :caption: examples/minimqtt_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..9208b98 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,45 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + +.. toctree:: + :caption: Related Products + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/minimqtt_adafruitio_wifi.py b/examples/minimqtt_adafruitio_wifi.py new file mode 100644 index 0000000..f93cd15 --- /dev/null +++ b/examples/minimqtt_adafruitio_wifi.py @@ -0,0 +1,88 @@ +import time +import board +import busio +from digitalio import DigitalInOut +import neopixel +from adafruit_esp32spi import adafruit_esp32spi +from adafruit_esp32spi import adafruit_esp32spi_wifimanager +import adafruit_esp32spi.adafruit_esp32spi_socket as socket +from adafruit_minimqtt import MQTT + +### WiFi ### + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# If you are using a board with pre-defined ESP32 Pins: +esp32_cs = DigitalInOut(board.ESP_CS) +esp32_ready = DigitalInOut(board.ESP_BUSY) +esp32_reset = DigitalInOut(board.ESP_RESET) + +# If you have an externally connected ESP32: +# esp32_cs = DigitalInOut(board.D9) +# esp32_ready = DigitalInOut(board.D10) +# esp32_reset = DigitalInOut(board.D5) + +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +"""Use below for Most Boards""" +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +# Uncomment below for an externally defined RGB LED +# import adafruit_rgbled +# from adafruit_esp32spi import PWMOut +# RED_LED = PWMOut.PWMOut(esp, 26) +# GREEN_LED = PWMOut.PWMOut(esp, 27) +# BLUE_LED = PWMOut.PWMOut(esp, 25) +# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +### Adafruit IO Setup ### + +# Setup a feed named `photocell` for publishing. +aio_publish_feed = secrets['user']+'/feeds/photocell' + +# Setup a feed named `onoffbutton` for subscribing to changes. +aio_subscribe_feed = secrets['user']+'/feeds/onoffbutton' + +### Code ### + +# pylint: disable=unused-argument +def on_message(client, topic, message): + # This method is called whenever a new message is received + # from the server. + print('New message on topic {0}: {1}'.format(topic, message)) + +# Connect to WiFi +wifi.connect() + +# Set up a MiniMQTT Client +mqtt_client = MQTT(socket, + broker = secrets['broker'], + username = secrets['user'], + password = secrets['pass'], + network_manager = wifi) + +# Attach on_message method to the MQTT Client +mqtt_client.on_message = on_message + +# Initialize the MQTT Client +mqtt_client.connect() + +# Subscribe the client to topic aio_subscribe_feed +mqtt_client.subscribe(aio_subscribe_feed) + +photocell_val = 0 +while True: + # Poll the message queue + mqtt_client.loop() + + print('Sending photocell value: %d'%photocell_val) + mqtt_client.publish(aio_publish_feed, photocell_val) + photocell_val += 1 + time.sleep(0.5) diff --git a/examples/minimqtt_pub_sub_blocking.py b/examples/minimqtt_pub_sub_blocking.py new file mode 100644 index 0000000..5831466 --- /dev/null +++ b/examples/minimqtt_pub_sub_blocking.py @@ -0,0 +1,96 @@ +# CircuitPython MiniMQTT Library +# Adafruit IO SSL/TLS Example for WiFi (ESP32SPI) +import board +import busio +from digitalio import DigitalInOut +import neopixel +from adafruit_esp32spi import adafruit_esp32spi +from adafruit_esp32spi import adafruit_esp32spi_wifimanager +import adafruit_esp32spi.adafruit_esp32spi_socket as socket +from adafruit_minimqtt import MQTT + +### WiFi ### + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# If you are using a board with pre-defined ESP32 Pins: +esp32_cs = DigitalInOut(board.ESP_CS) +esp32_ready = DigitalInOut(board.ESP_BUSY) +esp32_reset = DigitalInOut(board.ESP_RESET) + +# If you have an externally connected ESP32: +# esp32_cs = DigitalInOut(board.D9) +# esp32_ready = DigitalInOut(board.D10) +# esp32_reset = DigitalInOut(board.D5) + +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +"""Use below for Most Boards""" +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +# Uncomment below for an externally defined RGB LED +# import adafruit_rgbled +# from adafruit_esp32spi import PWMOut +# RED_LED = PWMOut.PWMOut(esp, 26) +# GREEN_LED = PWMOut.PWMOut(esp, 27) +# BLUE_LED = PWMOut.PWMOut(esp, 25) +# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +### Adafruit IO Setup ### + +# Setup a feed named `testfeed` for publishing. +default_topic = secrets['user']+'/feeds/testfeed' + +### Code ### + +# Define callback methods which are called when events occur +# pylint: disable=unused-argument, redefined-outer-name +def connected(client, userdata, flags, rc): + # This function will be called when the client is connected + # successfully to the broker. + print('Connected to MQTT broker! Listening for topic changes on %s'%default_topic) + # Subscribe to all changes on the default_topic feed. + client.subscribe(default_topic) + +def disconnected(client, userdata, rc): + # This method is called when the client is disconnected + print('Disconnected from MQTT Broker!') + +def message(client, topic, message): + """Method callled when a client's subscribed feed has a new + value. + :param str topic: The topic of the feed with a new value. + :param str message: The new value + """ + print('New message on topic {0}: {1}'.format(topic, message)) + +# Connect to WiFi +wifi.connect() + +# Set up a MiniMQTT Client +mqtt_client = MQTT(socket, + broker = secrets['broker'], + username = secrets['user'], + password = secrets['pass'], + network_manager = wifi) + +# Setup the callback methods above +mqtt_client.on_connect = connected +mqtt_client.on_disconnect = disconnected +mqtt_client.on_message = message + +# Connect the client to the MQTT broker. +mqtt_client.connect() + +# Start a blocking message loop +# If you only want to listen to incoming messages, +# you'll want to loop_forever as it handles network reconnections +# No code below this line will execute. +mqtt_client.loop_forever() diff --git a/examples/minimqtt_pub_sub_nonblocking.py b/examples/minimqtt_pub_sub_nonblocking.py new file mode 100644 index 0000000..fdde9a7 --- /dev/null +++ b/examples/minimqtt_pub_sub_nonblocking.py @@ -0,0 +1,99 @@ +import time +import board +import busio +from digitalio import DigitalInOut +import neopixel +from adafruit_esp32spi import adafruit_esp32spi +from adafruit_esp32spi import adafruit_esp32spi_wifimanager +import adafruit_esp32spi.adafruit_esp32spi_socket as socket +from adafruit_minimqtt import MQTT + +### WiFi ### + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# If you are using a board with pre-defined ESP32 Pins: +esp32_cs = DigitalInOut(board.ESP_CS) +esp32_ready = DigitalInOut(board.ESP_BUSY) +esp32_reset = DigitalInOut(board.ESP_RESET) + +# If you have an externally connected ESP32: +# esp32_cs = DigitalInOut(board.D9) +# esp32_ready = DigitalInOut(board.D10) +# esp32_reset = DigitalInOut(board.D5) + +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +"""Use below for Most Boards""" +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +# Uncomment below for an externally defined RGB LED +# import adafruit_rgbled +# from adafruit_esp32spi import PWMOut +# RED_LED = PWMOut.PWMOut(esp, 26) +# GREEN_LED = PWMOut.PWMOut(esp, 27) +# BLUE_LED = PWMOut.PWMOut(esp, 25) +# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +### Adafruit IO Setup ### + +# Setup a feed named `testfeed` for publishing. +default_topic = secrets['user']+'/feeds/testfeed' + +### Code ### +# Define callback methods which are called when events occur +# pylint: disable=unused-argument, redefined-outer-name +def connected(client, userdata, flags, rc): + # This function will be called when the client is connected + # successfully to the broker. + print('Connected to MQTT broker! Listening for topic changes on %s'%default_topic) + # Subscribe to all changes on the default_topic feed. + client.subscribe(default_topic) + +def disconnected(client, userdata, rc): + # This method is called when the client is disconnected + print('Disconnected from MQTT Broker!') + +def message(client, topic, message): + """Method callled when a client's subscribed feed has a new + value. + :param str topic: The topic of the feed with a new value. + :param str message: The new value + """ + print('New message on topic {0}: {1}'.format(topic, message)) + +# Connect to WiFi +wifi.connect() + +# Set up a MiniMQTT Client +mqtt_client = MQTT(socket, + broker = secrets['broker'], + username = secrets['user'], + password = secrets['pass'], + network_manager = wifi) + +# Setup the callback methods above +mqtt_client.on_connect = connected +mqtt_client.on_disconnect = disconnected +mqtt_client.on_message = message + +# Connect the client to the MQTT broker. +mqtt_client.connect() + +photocell_val = 0 +while True: + # Poll the message queue + mqtt_client.loop() + + # Send a new message + print('Sending photocell value: %d'%photocell_val) + mqtt_client.publish(default_topic, photocell_val) + photocell_val += 1 + time.sleep(0.5) diff --git a/examples/minimqtt_simpletest.py b/examples/minimqtt_simpletest.py new file mode 100644 index 0000000..a600c69 --- /dev/null +++ b/examples/minimqtt_simpletest.py @@ -0,0 +1,112 @@ +import board +import busio +from digitalio import DigitalInOut +import neopixel +from adafruit_esp32spi import adafruit_esp32spi +from adafruit_esp32spi import adafruit_esp32spi_wifimanager +import adafruit_esp32spi.adafruit_esp32spi_socket as socket + +from adafruit_minimqtt import MQTT + +### WiFi ### + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# If you are using a board with pre-defined ESP32 Pins: +esp32_cs = DigitalInOut(board.ESP_CS) +esp32_ready = DigitalInOut(board.ESP_BUSY) +esp32_reset = DigitalInOut(board.ESP_RESET) + +# If you have an externally connected ESP32: +# esp32_cs = DigitalInOut(board.D9) +# esp32_ready = DigitalInOut(board.D10) +# esp32_reset = DigitalInOut(board.D5) + +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +"""Use below for Most Boards""" +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +# Uncomment below for an externally defined RGB LED +# import adafruit_rgbled +# from adafruit_esp32spi import PWMOut +# RED_LED = PWMOut.PWMOut(esp, 26) +# GREEN_LED = PWMOut.PWMOut(esp, 27) +# BLUE_LED = PWMOut.PWMOut(esp, 25) +# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +### Topic Setup ### + +# MQTT Topic +# Use this topic if you'd like to connect to a standard MQTT broker +mqtt_topic = 'test/topic' + +# Adafruit IO-style Topic +# Use this topic if you'd like to connect to io.adafruit.com +# mqtt_topic = 'aio_user/feeds/temperature' + +### Code ### + +# Define callback methods which are called when events occur +# pylint: disable=unused-argument, redefined-outer-name +def connect(client, userdata, flags, rc): + # This function will be called when the client is connected + # successfully to the broker. + print('Connected to MQTT Broker!') + print('Flags: {0}\n RC: {1}'.format(flags, rc)) + +def disconnect(client, userdata, rc): + # This method is called when the client disconnects + # from the broker. + print('Disconnected from MQTT Broker!') + +def subscribe(client, userdata, topic, granted_qos): + # This method is called when the client subscribes to a new feed. + print('Subscribed to {0} with QOS level {1}'.format(topic, granted_qos)) + +def unsubscribe(client, userdata, topic, pid): + # This method is called when the client unsubscribes from a feed. + print('Unsubscribed from {0} with PID {1}'.format(topic, pid)) + +def publish(client, userdata, topic, pid): + # This method is called when the client publishes data to a feed. + print('Published to {0} with PID {1}'.format(topic, pid)) + +# Connect to WiFi +wifi.connect() + +# Set up a MiniMQTT Client +client = MQTT(socket, + broker = secrets['broker'], + username = secrets['user'], + password = secrets['pass'], + network_manager = wifi) + +# Connect callback handlers to client +client.on_connect = connect +client.on_disconnect = disconnect +client.on_subscribe = subscribe +client.on_unsubscribe = unsubscribe +client.on_publish = publish + +print('Attempting to connect to %s'%client.broker) +client.connect() + +print('Subscribing to %s'%mqtt_topic) +client.subscribe(mqtt_topic) + +print('Publishing to %s'%mqtt_topic) +client.publish(mqtt_topic, 'Hello Broker!') + +print('Unsubscribing from %s'%mqtt_topic) +client.unsubscribe(mqtt_topic) + +print('Disconnecting from %s'%client.broker) +client.disconnect() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..edf9394 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Adafruit-Blinka diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c0efb71 --- /dev/null +++ b/setup.py @@ -0,0 +1,63 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-minimqtt', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='MQTT client library for CircuitPython', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython minimqtt mqtt, client, socket', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_minimqtt'], +)