diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: source actions-ci/install.sh - name: Pip install pylint, black, & Sphinx run: | - pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme + pip install pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_aws_iot.py b/adafruit_aws_iot.py index 861abb5..540120d 100644 --- a/adafruit_aws_iot.py +++ b/adafruit_aws_iot.py @@ -49,9 +49,11 @@ class AWS_IOT_ERROR(Exception): """Exception raised on MQTT API return-code errors.""" + # pylint: disable=unnecessary-pass pass + class MQTT_CLIENT: """Client for interacting with Amazon AWS IoT MQTT API. @@ -60,24 +62,33 @@ class MQTT_CLIENT: Provided interval must be 30 <= keep_alive <= 1200. """ + def __init__(self, mmqttclient, keep_alive=30): if "MQTT" in str(type(mmqttclient)): self.client = mmqttclient else: - raise TypeError("This class requires a preconfigured MiniMQTT object, \ - please create one.") + raise TypeError( + "This class requires a preconfigured MiniMQTT object, \ + please create one." + ) # Verify MiniMQTT client object configuration try: self.cid = self.client.client_id - assert self.cid[0] != "$", "Client ID can not start with restricted client ID prefix $." + assert ( + self.cid[0] != "$" + ), "Client ID can not start with restricted client ID prefix $." except: - raise TypeError("You must provide MiniMQTT with your AWS IoT Device's Identifier \ - as the Client ID.") + raise TypeError( + "You must provide MiniMQTT with your AWS IoT Device's Identifier \ + as the Client ID." + ) # Shadow-interaction topic self.shadow_topic = "$aws/things/{}/shadow".format(self.cid) # keep_alive timer must be between 30 <= keep alive interval <= 1200 seconds # https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html - assert 30 <= keep_alive <= 1200, "Keep_Alive timer \ + assert ( + 30 <= keep_alive <= 1200 + ), "Keep_Alive timer \ interval must be between 30 and 1200 seconds" self.keep_alive = keep_alive # User-defined MQTT callback methods must be init'd to None @@ -100,7 +111,6 @@ def __enter__(self): def __exit__(self, exception_type, exception_value, traceback): self.disconnect() - @property def is_connected(self): """Returns if MQTT_CLIENT is connected to AWS IoT MQTT Broker @@ -115,7 +125,7 @@ def disconnect(self): try: self.client.disconnect() except MMQTTException as error: - raise AWS_IOT_ERROR('Error disconnecting with AWS IoT: ', error) + raise AWS_IOT_ERROR("Error disconnecting with AWS IoT: ", error) self.connected_to_aws = False # Reset user-defined callback methods to None self.on_connect = None @@ -133,7 +143,7 @@ def connect(self, clean_session=True): try: self.client.connect(clean_session) except MMQTTException as error: - raise AWS_IOT_ERROR('Error connecting to AWS IoT: ', error) + raise AWS_IOT_ERROR("Error connecting to AWS IoT: ", error) self.connected_to_aws = True # MiniMQTT Callback Handlers @@ -265,30 +275,34 @@ def shadow_get_subscribe(self, qos=1): :param int qos: Optional quality of service level. """ - self.client.subscribe(self.shadow_topic+"/get/#", qos) + self.client.subscribe(self.shadow_topic + "/get/#", qos) def shadow_subscribe(self, qos=1): """Subscribes to all notifications on the device's shadow update topic. :param int qos: Optional quality of service level. """ - self.client.subscribe(self.shadow_topic+"/update/#", qos) + self.client.subscribe(self.shadow_topic + "/update/#", qos) def shadow_update(self, document): """Publishes a request state document to update the device's shadow. :param json state_document: JSON-formatted state document. """ - self.client.publish(self.shadow_topic+"/update", document) + self.client.publish(self.shadow_topic + "/update", document) def shadow_get(self): """Publishes an empty message to shadow get topic to get the device's shadow. """ - self.client.publish(self.shadow_topic+"/get", json.dumps({"message": "ignore"})) + self.client.publish( + self.shadow_topic + "/get", json.dumps({"message": "ignore"}) + ) def shadow_delete(self): """Publishes an empty message to the shadow delete topic to delete a device's shadow """ - self.client.publish(self.shadow_topic+"/delete", json.dumps({"message": "delete"})) + self.client.publish( + self.shadow_topic + "/delete", json.dumps({"message": "delete"}) + ) diff --git a/docs/conf.py b/docs/conf.py index 3413d63..79daa58 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,32 @@ autodoc_mock_imports = ["adafruit_minimqtt"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +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'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit AWS_IOT Library' -copyright = u'2019 Brent Rubell' -author = u'Brent Rubell' +project = "Adafruit AWS_IOT Library" +copyright = "2019 Brent Rubell" +author = "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' +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -57,7 +61,7 @@ # 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'] +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. @@ -69,7 +73,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +88,62 @@ # 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' +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(), '.'] + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] except: - html_theme = 'default' - html_theme_path = ['.'] + html_theme = "default" + html_theme_path = ["."] else: - html_theme_path = ['.'] + 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'] +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' +html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitAws_iotLibrarydoc' +htmlhelp_basename = "AdafruitAws_iotLibrarydoc" # -- 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', + # 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, 'AdafruitAWS_IOTLibrary.tex', u'AdafruitAWS_IOT Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitAWS_IOTLibrary.tex", + "AdafruitAWS_IOT Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitAWS_IOTlibrary', u'Adafruit AWS_IOT Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitAWS_IOTlibrary", + "Adafruit AWS_IOT Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitAWS_IOTLibrary', u'Adafruit AWS_IOT Library Documentation', - author, 'AdafruitAWS_IOTLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitAWS_IOTLibrary", + "Adafruit AWS_IOT Library Documentation", + author, + "AdafruitAWS_IOTLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/aws_iot_shadows.py b/examples/aws_iot_shadows.py index 7690f67..9923518 100644 --- a/examples/aws_iot_shadows.py +++ b/examples/aws_iot_shadows.py @@ -48,10 +48,14 @@ esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) # Verify nina-fw version >= 1.4.0 -assert int(bytes(esp.firmware_version).decode("utf-8")[2]) >= 4, "Please update nina-fw to >=1.4.0." +assert ( + int(bytes(esp.firmware_version).decode("utf-8")[2]) >= 4 +), "Please update nina-fw to >=1.4.0." # Use below for Most Boards -status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment 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 @@ -70,24 +74,26 @@ 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)) + print("Connected to MQTT Broker!") + print("Flags: {0}\n RC: {1}".format(flags, rc)) # Subscribe client to all shadow updates print("Subscribing to shadow updates...") aws_iot.shadow_subscribe() + def disconnect(client, userdata, rc): # This method is called when the client disconnects # from the broker. - print('Disconnected from MQTT Broker!') + print("Disconnected from MQTT Broker!") + def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new topic. - print('Subscribed to {0} with QOS level {1}'.format(topic, granted_qos)) + print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) # Update device shadow with example JSON payload - payload = {"state":{"reported":{"moisture":50,"temp":30}}} + payload = {"state": {"reported": {"moisture": 50, "temp": 30}}} aws_iot.shadow_update(json.dumps(payload)) # We can also retrieve the shadow from AWS IoT, @@ -96,18 +102,22 @@ def subscribe(client, userdata, topic, granted_qos): # or delete the shadow # aws_iot.shadow_delete() + def unsubscribe(client, userdata, topic, pid): # This method is called when the client unsubscribes from a topic. - print('Unsubscribed from {0} with PID {1}'.format(topic, pid)) + 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 topic. - print('Published to {0} with PID {1}'.format(topic, pid)) + print("Published to {0} with PID {1}".format(topic, pid)) + def message(client, topic, msg): # This method is called when the client receives data from a topic. print("Message from {}: {}".format(topic, msg)) + # Set AWS Device Certificate esp.set_certificate(DEVICE_CERT) @@ -121,11 +131,13 @@ def message(client, topic, msg): # Set up a new MiniMQTT Client -client = MQTT(socket, - broker = secrets['broker'], - client_id = secrets['client_id'], - network_manager = wifi, - log=True) +client = MQTT( + socket, + broker=secrets["broker"], + client_id=secrets["client_id"], + network_manager=wifi, + log=True, +) # Initialize AWS IoT MQTT API Client aws_iot = MQTT_CLIENT(client) @@ -138,7 +150,7 @@ def message(client, topic, msg): aws_iot.on_publish = publish aws_iot.on_message = message -print('Attempting to connect to %s'%client.broker) +print("Attempting to connect to %s" % client.broker) aws_iot.connect() # Pump the message loop forever, all events diff --git a/examples/aws_iot_simpletest.py b/examples/aws_iot_simpletest.py index 3d7dd67..81e6dff 100644 --- a/examples/aws_iot_simpletest.py +++ b/examples/aws_iot_simpletest.py @@ -48,10 +48,14 @@ esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) # Verify nina-fw version >= 1.4.0 -assert int(bytes(esp.firmware_version).decode("utf-8")[2]) >= 4, "Please update nina-fw to >=1.4.0." +assert ( + int(bytes(esp.firmware_version).decode("utf-8")[2]) >= 4 +), "Please update nina-fw to >=1.4.0." # Use below for Most Boards -status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment 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 @@ -72,34 +76,39 @@ 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)) + print("Connected to MQTT Broker!") + print("Flags: {0}\n RC: {1}".format(flags, rc)) # Subscribe to topic circuitpython/aws print("Subscribing to topic {}".format(topic)) aws_iot.subscribe(topic) + def disconnect(client, userdata, rc): # This method is called when the client disconnects # from the broker. - print('Disconnected from MQTT Broker!') + print("Disconnected from MQTT Broker!") + def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new topic. - print('Subscribed to {0} with QOS level {1}'.format(topic, granted_qos)) + print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) # Create a json-formatted message message = {"message": "Hello from AWS IoT CircuitPython"} # Publish message to topic aws_iot.publish(topic, json.dumps(message)) + def unsubscribe(client, userdata, topic, pid): # This method is called when the client unsubscribes from a topic. - print('Unsubscribed from {0} with PID {1}'.format(topic, pid)) + 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 topic. - print('Published to {0} with PID {1}'.format(topic, pid)) + print("Published to {0} with PID {1}".format(topic, pid)) + def message(client, topic, msg): # This method is called when the client receives data from a topic. @@ -118,11 +127,13 @@ def message(client, topic, msg): print("Connected!") # Set up a new MiniMQTT Client -client = MQTT(socket, - broker = secrets['broker'], - client_id = secrets['client_id'], - network_manager = wifi, - log=True) +client = MQTT( + socket, + broker=secrets["broker"], + client_id=secrets["client_id"], + network_manager=wifi, + log=True, +) # Initialize AWS IoT MQTT API Client aws_iot = MQTT_CLIENT(client) @@ -135,7 +146,7 @@ def message(client, topic, msg): aws_iot.on_publish = publish aws_iot.on_message = message -print('Attempting to connect to %s'%client.broker) +print("Attempting to connect to %s" % client.broker) aws_iot.connect() # Pump the message loop forever, all events diff --git a/setup.py b/setup.py index a045f5c..1bfa3f8 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,52 +14,41 @@ 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: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-aws-iot', - + name="adafruit-circuitpython-aws-iot", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='Amazon AWS IoT MQTT Client for CircuitPython', + setup_requires=["setuptools_scm"], + description="Amazon AWS IoT MQTT Client for CircuitPython", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT', - + url="https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=[ - 'Adafruit-Blinka' - ], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # Choose your license - license='MIT', - + 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', + "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 aws_iot aws, iot, amazon, mqtt, ' - 'client', - + keywords="adafruit blinka circuitpython micropython aws_iot aws, iot, amazon, mqtt, " + "client", # 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_aws_iot'], + py_modules=["adafruit_aws_iot"], )