From cbc5e19ca47ed6df77cd8c556b641c6b15741e0e Mon Sep 17 00:00:00 2001
From: Chris Caron <lead2gold@gmail.com>
Date: Thu, 16 Sep 2021 23:01:48 -0400
Subject: [PATCH] Created Notify_mqtt (markdown)

---
 Notify_mqtt.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 Notify_mqtt.md

diff --git a/Notify_mqtt.md b/Notify_mqtt.md
new file mode 100644
index 0000000..7e46d18
--- /dev/null
+++ b/Notify_mqtt.md
@@ -0,0 +1,44 @@
+## MQTT Notifications
+* **Source**: https://mqtt.org/
+* **Icon Support**: No
+* **Message Format**: Text
+* **Message Limit**: 268435455 Characters per Message
+
+MQTT Support requires **paho-mqtt** to work:
+```bash
+pip install paho-mqtt
+```
+
+### Syntax
+Valid syntax is as follows:
+- `mqtt://{host}/{topic}`
+- `mqtt://{host}:{port}/{topic}`
+- `mqtt://{user}@{host}:{port}/{topic}`
+- `mqtt://{user}:{password}@{host}:{port}/{topic}`
+
+For a secure connection, just use `mqtts` instead.
+- `mqtts://{host}/{topic}`
+- `mqtts://{host}:{port}/{topic}`
+- `mqtts://{user}@{host}:{port}/{topic}`
+- `mqtts://{user}:{password}@{host}:{port}/{topic}`
+
+Secure connections should be referenced using **mqtts://** where as insecure connections should be referenced via **mqtt://**.
+
+### Parameter Breakdown
+| Variable    | Required | Description
+| ----------- | -------- | -----------
+| user        | no       | The user associated with your MQTT server.
+| password    | no       | The password associated with your MQTT server.
+| hostname    | Yes      | The MQTT server you're sending your notification to.
+| port        | No       | The port the MQTT server is listening on. By default the port is **1883** for **mqtt://** and **8883** for all **mqtts://** references.
+| qos     | No      | The MQTT Quality of Service (Qos) setting.  By default this is set to **0** (_zero_).
+| version       | No       |  The MQTT Protocol Version to use.  By default this is set to **v3.1.1**. The other possible values are **v3.1** and **v5**.
+| client_id     | No      | The MQTT client identifier to use when establishing a connection with the server.  By default this is not set and a unique ID is generated per message.
+| session     | No      | The MQTT session to maintain (associated with the client_id).  If no client_id is specified, then this value is not considered.  By default there is no session established and each connection made by apprise is unique.  If you wish to enforce a session (associated with a provided client_id) then set this value to True.
+
+#### Example
+```bash
+# Assuming we're just running an MQTT Server locally on your box
+# Assuming we want to post our message to the topic: `my/topic`
+apprise -vvv -b "whatever-payload-want" "mqtt://localhost/my/topic"
+```
\ No newline at end of file