From 96a345e9e3de6d8da718b174d2cb2bd7e451b957 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roland=20Hu=C3=9F?= Date: Tue, 12 Nov 2024 10:30:24 +0100 Subject: [PATCH] describe mqtt support when sending out events --- docs/reference/configuration/messaging.md | 29 +++++++++++++++++++++++ docs/reference/configuration/mqtt.md | 1 + 2 files changed, 30 insertions(+) diff --git a/docs/reference/configuration/messaging.md b/docs/reference/configuration/messaging.md index e4786fe1a..96b91b1e5 100644 --- a/docs/reference/configuration/messaging.md +++ b/docs/reference/configuration/messaging.md @@ -237,6 +237,7 @@ Im folgenden werden nun alle erforderlichen Parameter erklärt. - `email`: Email. Siehe [`email`](#email) Definition - `shout`: [shoutrrr](https://containrrr.dev/shoutrrr). Siehe [`shout`](#shout) Definition - `script`: Kann externe Skripte zum Versenden von Nachrichten starten. Es ist auch hilfreich, um jede Art von externer Funktionalität einzubinden. Siehe [`script`](#script) Definition +- `mqtt`: Sendet eine MQTT Nachricht an den in [`mqtt`](/docs/reference/configuration/messaging.md) konfigurierten MQTT server. **Beispiel**: @@ -350,3 +351,31 @@ Der Pfad zum Script muß in `cmdline` angegeben werden. Ebenso sollte ein `timeo cmdline: /home/pi/sendSignalMessage.sh timeout: 50s ``` + +### `mqtt` + +`mqtt` versendet die Nachrichten über MQTT in das mit `topic` definierte Topic (default: `evecc/events`). +Um diesen Service nutzen zu können muss wie ein MQTT Server konfiguriert sein. Siehe [`mqtt`](/docs/reference/configuration/messaging.md) für mehr Informationen. + +Ein in `events` definierter `title` wird ignoriert, es wird nur die `msg` and das MQTT topic gesendet. Die einzige Ausnahme: Falls die `msg` ein JSON Objekt ist, wird der Titel mit dem Key `title` in das JSON Objekt eingefügt bevor diese über MQTT verschickt wird. + +**Beispiel**: + +```yaml + +# MQTT Broker Configuration +mqtt: + broker: broker.mqtt:1883 + user: evcc + password: s3cr3t + +# Send lifecycle events via MQTT +messaging: + events: + connect: + # Use template to create JSON payload + msg: '{"car": "${vehicleTitle}", "mode": "${mode}", "event": "connect"}' + services: + - type: mqtt + topic: 'evcc/events' +``` diff --git a/docs/reference/configuration/mqtt.md b/docs/reference/configuration/mqtt.md index 7ff3b6880..b7de0634f 100644 --- a/docs/reference/configuration/mqtt.md +++ b/docs/reference/configuration/mqtt.md @@ -6,6 +6,7 @@ sidebar_position: 14 Stellt die Konnektivität mit einem MQTT-Broker her. Bei bestehender Verbindung pusht evcc automatisch alle internen Werte via MQTT-Broker auf das angegebene Topic und empfängt dort auch Änderungen. +Der konfigurierte MQTT Server kann auch als ein Service genutzt werden um die in [`messaging`](/docs/reference/configuration/messaging.md) konfigurierten Events zu verschicken. Siehe dazu auch die Dokumentation zur [`MQTT API`](/docs/integrations/mqtt-api). ---