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 2021-09-16 23:31:17 -04:00
parent 04813ed878
commit 9d54c6de08
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Notify_mqtt.md

@ -36,9 +36,35 @@ Secure connections should be referenced using **mqtts://** where as insecure con
| 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. | 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. | 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 ### Example
```bash ```bash
# Assuming we're just running an MQTT Server locally on your box # Assuming we're just running an MQTT Server locally on your box
# Assuming we want to post our message to the topic: `my/topic` # Assuming we want to post our message to the topic: `my/topic`
apprise -vvv -b "whatever-payload-want" "mqtt://localhost/my/topic" apprise -vvv -b "whatever-payload-want" "mqtt://localhost/my/topic"
```
#### Sample Service Setup
I did the following to test this service locally (using docker):
```bash
# Pull in Mosquitto (v2.x at the time) - 2021 Sept 16th
docker pull eclipse-mosquitto
# Set up a spot for our configuration
mkdir mosquitto
cd mosquitto
cat << _EOF > mosquitto.conf
persistence false
allow_anonymous true
connection_messages true
log_type all
listener 1883
_EOF
# Now spin up an instance (we can Ctrl-C out of when we're done):
docker run --name mosquitto -p 1883:1883 \
--rm -v $(pwd)/mosquitto.conf:/mosquitto/config/mosquitto.conf \
eclipse-mosquitto
# All apprise testing can be done against this systems IP such as:
# apprise -vvv -b "my=payload" mqtt://localhost/a/simple/topic
``` ```