github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_mqtt (markdown)

master
Chris Caron 2024-09-02 16:48:56 -04:00
parent b5a5016058
commit bd4459f4d1
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Notify_mqtt.md

@ -35,6 +35,7 @@ Secure connections should be referenced using **mqtts://** where as insecure con
| 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.
| retain | No | The MQTT publisher retain flag. By default this is set to `no`, but you may optionally over-ride it and set it to `yes`
### Example
```bash
@ -67,4 +68,7 @@ docker run --name mosquitto -p 1883:1883 \
# All apprise testing can be done against this systems IP such as:
# apprise -vvv -b "my=payload" mqtt://localhost/a/simple/topic
# Here is an example where the 'retain' flag is set:
apprise -vvv -b "my=payload" mqtt://localhost/a/simple/topic?retain=yes
```