Skip to content

Commit

Permalink
describe mqtt support when sending out events
Browse files Browse the repository at this point in the history
  • Loading branch information
rhuss committed Nov 15, 2024
1 parent c475400 commit 9d824a2
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/reference/configuration/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:

Expand Down Expand Up @@ -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'
```
1 change: 1 addition & 0 deletions docs/reference/configuration/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

---
Expand Down

0 comments on commit 9d824a2

Please sign in to comment.