Update docs, format code etc.

Author: flyte

Makefile

@@ -1,38 +1,29 @@
+.PHONY: docs
+
 black:
 	black -l 90 mqtt_io
 
-packages: clean schema sdist wheel2 wheel3
-
-sdist: schema
-	python setup.py sdist
-
-wheel3: schema
-	python3 setup.py bdist_wheel
-
 clean:
-	find pi_mqtt_gpio -type d -name __pycache__ -prune -exec rm -rf {} \;
+	find mqtt_io -type d -name __pycache__ -prune -exec rm -rf {} \;
 	rm -rf dist .eggs .mypy_cache .pytest_cache *.egg-info
 
-upload: packages
-	twine upload dist/*
-	$(MAKE) clean
-
 graphs:
 	dot -Tsvg -O interrupt_handling.dot
 	dot -Tsvg -O interrupt_callbacks.dot
 
 coverage:
-	coverage run --source "." --omit "mqtt_io/tests/*,mqtt_io/modules/*" -m behave mqtt_io/tests/features
+	coverage run --source "." --omit "mqtt_io/tests/*,mqtt_io/modules/*" -m behave mqtt_io/tests/features -t ~skip
 	coverage report -m
 
-requirements:
-	poetry export > requirements.txt
-	echo "hbmqtt==0.9.6" >> requirements.txt
-
 lint:
 	pylint -d fixme mqtt_io
 	mypy --show-error-codes --strict --no-warn-unused-ignores mqtt_io
 
-publish:
+build:
 	poetry build
+
+publish: build
 	poetry publish
+
+docs:
+	poetry run python docs/generate_docs.py

docs/CHANGELOG.md

@@ -1,5 +1,9 @@
 Unreleased
 ==========
+- Auto-reconnect to MQTT server on disconnection. #207 @fipwmaqzufheoxq92ebc
+
+v2.1.8 - 2021-04-21
+===================
 - Fix broken hcsr04 sensor that I (@flyte) broke when rewriting for v2.x. #211 @r00tat
 - Fix inversion not taken into account when publishing initial digital output value. #203 @r00tat
 - Fix #198 where Future wasn't created from the right thread. #205 @fipwmaqzufheoxq92ebc

docs/config/reference/mqtt/README.md

@@ -415,3 +415,31 @@ Do not use this function in a real system. Setting value to true means there
 is no point using encryption.
 
 
+## reconnect_delay :id=mqtt-reconnect_delay
+
+*mqtt*.**reconnect_delay**
+
+Time in seconds to wait between reconnect attempts.
+
+
+```yaml
+Type: integer
+Required: False
+Default: 2
+```
+
+## reconnect_count :id=mqtt-reconnect_count
+
+*mqtt*.**reconnect_count**
+
+Max number of retries of connections before giving up and exiting.
+-1 (the default) means infinite reconnects.
+The counter is reset when the connection is reestablished successfully.
+
+
+```yaml
+Type: integer
+Required: False
+Default: -1
+```
+

docs/dev/modules/README.md

@@ -142,7 +142,7 @@ def setup_module(self) -> None:
 
 If a digital input is not configured as an [interrupt](config/interrupts.md) (or even [sometimes if it is](config/reference/digital_inputs/?id=digital_inputs-star-interrupt_for)), then a loop will be created which polls the pin's current value and publishes a `DigitalInputChangedEvent` event when it does. As part of the initialisation of each pin, a callback function to publish the new value on MQTT will be subscribed to this event.
 
-[mqtt_io.server.MqttIo._init_digital_inputs](https://github.com/flyte/mqtt-io/blob/develop/mqtt_io/server.py#L343):
+[mqtt_io.server.MqttIo._init_digital_inputs](https://github.com/flyte/mqtt-io/blob/develop/mqtt_io/server.py#L344):
 
 ```python
 def _init_digital_inputs(self) -> None:

generate_docs.py renamed to docs/generate_docs.py

@@ -14,12 +14,12 @@
 
 from mqtt_io.types import ConfigType
 
-THIS_DIR = pathlib.Path(__file__).parent.absolute()
-CONFIG_SCHEMA_PATH = join(THIS_DIR, "mqtt_io/config/config.schema.yml")
-README_TEMPLATE = join(THIS_DIR, "README.md.j2")
-MODULES_DIR = join(THIS_DIR, "mqtt_io/modules")
+WORKSPACE_DIR = pathlib.Path(__file__).parent.parent.absolute()
+CONFIG_SCHEMA_PATH = join(WORKSPACE_DIR, "mqtt_io/config/config.schema.yml")
+README_TEMPLATE = join(WORKSPACE_DIR, "README.md.j2")
+MODULES_DIR = join(WORKSPACE_DIR, "mqtt_io/modules")
 
-DOCS_DIR = join(THIS_DIR, "docs")
+DOCS_DIR = join(WORKSPACE_DIR, "docs")
 SIDEBAR_TEMPLATE = join(DOCS_DIR, "_sidebar.md.j2")
 CONTENT_TEMPLATE = join(DOCS_DIR, "config/reference.md.j2")
 MODULES_DOC_TEMPLATE = join(DOCS_DIR, "dev/modules/README.md.j2")
@@ -138,7 +138,7 @@ def generate_readmes() -> None:
     with open(README_TEMPLATE) as readme_template_file:
         readme_template: Template = Template(readme_template_file.read())
 
-    with open(join(THIS_DIR, "README.md"), "w") as readme_file:
+    with open(join(WORKSPACE_DIR, "README.md"), "w") as readme_file:
         readme_file.write(
             readme_template.render(dict(repo=True, supported_hardware=module_strings))
         )
@@ -151,7 +151,7 @@ def generate_readmes() -> None:
 
 def generate_changelog() -> None:
     print("Copying changelog...")
-    shutil.copyfile(join(THIS_DIR, "CHANGELOG.md"), join(DOCS_DIR, "CHANGELOG.md"))
+    shutil.copyfile(join(WORKSPACE_DIR, "CHANGELOG.md"), join(DOCS_DIR, "CHANGELOG.md"))
 
 
 def document_gpio_module() -> None:
@@ -186,7 +186,7 @@ def get_source(module_path: str, xpath: str, title: str) -> str:
     module_filepath = pathlib.Path(module.__file__)
     src, attrib = module_source(module, xpath)[0]
     url = "https://github.com/flyte/mqtt-io/blob/develop/%s#L%s" % (
-        module_filepath.relative_to(THIS_DIR),
+        module_filepath.relative_to(WORKSPACE_DIR),
         attrib["lineno"],
     )
     return f"[{title}]({url}):\n\n```python\n{src.rstrip()}\n```"
@@ -197,7 +197,7 @@ def get_source_link(module_path: str, xpath: str, title: str) -> str:
     module_filepath = pathlib.Path(module.__file__)
     _, attrib = module_source(module, xpath)[0]
     url = "https://github.com/flyte/mqtt-io/blob/develop/%s#L%s" % (
-        module_filepath.relative_to(THIS_DIR),
+        module_filepath.relative_to(WORKSPACE_DIR),
         attrib["lineno"],
     )
     return f"[{title}]({url}):"

docs/schema.json

@@ -271,6 +271,26 @@
             "default": false
           }
         }
+      },
+      "reconnect_delay": {
+        "meta": {
+          "description": "Time in seconds to wait between reconnect attempts.\n",
+          "title_id": "mqtt-reconnect_delay"
+        },
+        "type": "integer",
+        "required": false,
+        "default": 2,
+        "min": 1
+      },
+      "reconnect_count": {
+        "meta": {
+          "description": "Max number of retries of connections before giving up and exiting.\n-1 (the default) means infinite reconnects.\nThe counter is reset when the connection is reestablished successfully.\n",
+          "title_id": "mqtt-reconnect_count"
+        },
+        "type": "integer",
+        "required": false,
+        "default": -1,
+        "min": -1
       }
     }
   },

mqtt_io/config/config.schema.yml

@@ -261,9 +261,9 @@ mqtt:
     reconnect_count:
       meta:
         description: |
-          Max number of retries of connections before giving up (and exiting).
+          Max number of retries of connections before giving up and exiting.
           -1 (the default) means infinite reconnects.
-          The counter is reset if a connection was established successfully.
+          The counter is reset when the connection is reestablished successfully.
       type: integer
       required: no
       default: -1