From cd2979ff5a9aabc764bfb627c6c09ab97cd6a6e3 Mon Sep 17 00:00:00 2001 From: premultiply <4681172+premultiply@users.noreply.github.com> Date: Fri, 19 Aug 2022 10:09:21 +0200 Subject: [PATCH 1/2] mqtt --- docs/reference/configuration/mqtt.md | 34 +++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/reference/configuration/mqtt.md b/docs/reference/configuration/mqtt.md index d6bfccbdf8..9d2ae0a1db 100644 --- a/docs/reference/configuration/mqtt.md +++ b/docs/reference/configuration/mqtt.md @@ -4,7 +4,9 @@ sidebar_position: 14 # `mqtt` -Ermöglicht es Daten per MQTT mit einem Broker auszutauschen. +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. +Siehe dazu auch die Dokumentation zur [`MQTT API`](/reference/api/#mqtt-api). **Beispiel**: @@ -13,6 +15,36 @@ Ermöglicht es Daten per MQTT mit einem Broker auszutauschen. mqtt: broker: localhost:1883 topic: evcc # root topic for publishing, set empty to disable publishing + # clientid: foo # user: # password: ``` + +--- + +## Erforderliche Parameter + +### `broker` + +Verbindungsdaten (Hostname/IP und Port) des verwendeten MQTT-Brokers zu dem sich evcc als Client verbinden soll. + +### `topic` + +Gibt das Wurzeltopic an welches evcc verwendet. +Wenn hier nichts angegeben wird findet keine MQTT-Kommunikation statt! + +--- + +## Optionale Parameter + +### `user` + +Der Benutzernamen zur Anmeldung am MQTT-Broker. + +### `password` + +Das Anmeldepasswort am MQTT-Broker. + +### `clientid` + +Erlaubt eine feste MQTT-Client ID vorzugegeben. Andernfalls wird diese dynamisch vergeben. From 728580313ea7d4ae5e668d81afb1fdbcf25766ef Mon Sep 17 00:00:00 2001 From: premultiply <4681172+premultiply@users.noreply.github.com> Date: Mon, 26 Sep 2022 12:40:33 +0200 Subject: [PATCH 2/2] Update docs/reference/configuration/mqtt.md Co-authored-by: Michael Geers --- docs/reference/configuration/mqtt.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/configuration/mqtt.md b/docs/reference/configuration/mqtt.md index 9d2ae0a1db..9ac9fe142a 100644 --- a/docs/reference/configuration/mqtt.md +++ b/docs/reference/configuration/mqtt.md @@ -6,7 +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. -Siehe dazu auch die Dokumentation zur [`MQTT API`](/reference/api/#mqtt-api). +Siehe dazu auch die Dokumentation zur [`MQTT API`](/docs/reference/api/#mqtt-api). **Beispiel**: