Skip to content

Commit

Permalink
Dokumentation updates for mqtt module configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
@msinn
msinn committed Jan 9, 2024
1 parent a9f81f7 commit 87acd50
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions doc/user/source/konfiguration/module/module_mqtt.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,19 @@ Datei *../etc/module.yaml*
# etc/module.yaml
mqtt:
module_name: mqtt
# enabled: False
# broker_host: 127.0.0.1
# broker_port: 1883
# broker_client: MQTT-module
# user: Benutzer
# password: Geheim
# broker_monitoring: False
# qos: 1
# bool_values: ['Falsch', 'Wahr']
# last_will_topic: devices/shng-module/$online
# last_will_payload: 'False'
# birth_topic: devices/shng-module/$online
# birth_payload: 'True'
# bool_values: ['Falsch', 'Wahr']
# user: Benutzer
# password: Geheim
.. note::
Expand All @@ -57,19 +59,34 @@ Datei *../etc/module.yaml*
+-------------------------+------------------------------------------------------------------------------------------------------+
| Parameter | Bemerkung |
+=========================+======================================================================================================+
| enabled | MQTT Unterstützung aktivieren oder deaktivieren. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| broker_host | **Optional**: DNS Name oder IP Adresse des MQTT Brokers. Wird **broker_host** nicht angegeben, wird |
| | angenommen, dass der Broker auf dem selben Rechner läuft wie SmartHomeNG und es wird **127.0.0.1** |
| | (localhost) genutzt. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| broker_port | **Optional**: Port auf dem der MQTT Broker hört. Wird **broker_port** nicht angegeben, wird der |
| | Standard Port **1883** genutzt. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| broker_client | **Optional**: Client Name für die Broker Kommunikation - Muss nur angegeben werden, falls mehrere |
| | SmartHomeNG Installationen zeitgleich mit dem selben Broker kommunizieren sollen. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| user | **Optional**: Benutzername des MQTT Brokers, falls dieser ein Login erfordert. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| password | **Optional**: Password des MQTT Brokers, falls dieser ein Login erfordert. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| broker_monitoring | **Optional**: Wenn dieser Parameter auf **True** gesetzt wird, werden Informationen des Brokers zum |
| | Message Durchsatz abgefragt und können im Admin-Interface angezeigt werden. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| qos | **Optional**: Legt fest, welche Quality-of-Service Anforderungen MQTT Messages beim Publish |
| | mitgegeben werden soll. Wird der Parameter nicht angegeben, wird als Standardwert **1** verwendet. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| bool_values | **Optional**: Legt fest, welche Werte als Payload für Topics verwendet werden sollen, wenn Werte vom |
| | Typ **bool** versendet werden sollen. Außerdem werden diese Werte auch auf eingehende MQTT Messages |
| | angewendet, die in Variablen des Typ **bool** eingelesen werden sollen. Für den Parameter |
| | **bool_values** muss eine Liste mit **zwei** Werten angegeben werden, wobei der erste Wert für |
| | **False** steht und der zweiter Wert für **True** |
+-------------------------+------------------------------------------------------------------------------------------------------+
| last_will_topic | **Optional**: Legt den Topic der MQTT last_will Message fest. Wird der Parameter nicht angegeben, |
| | wird beim Verbindungsaufbau keine last_will Message festgelegt. |
+-------------------------+------------------------------------------------------------------------------------------------------+
Expand All @@ -83,14 +100,4 @@ Datei *../etc/module.yaml*
| birth_payload | **Optional**: Legt die Payload der birth Message fest. Wird der Parameter nicht angegeben, wird beim |
| | Verbindungsaufbau eine birth Message ohne Payload versendet. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| bool_values | **Optional**: Legt fest, welche Werte als Payload für Topics verwendet werden sollen, wenn Werte vom |
| | Typ **bool** versendet werden sollen. Außerdem werden diese Werte auch auf eingehende MQTT Messages |
| | angewendet, die in Variablen des Typ **bool** eingelesen werden sollen. Für den Parameter |
| | **bool_values** muss eine Liste mit **zwei** Werten angegeben werden, wobei der erste Wert für |
| | **False** steht und der zweiter Wert für **True** |
+-------------------------+------------------------------------------------------------------------------------------------------+
| user | **Optional**: Benutzername des MQTT Brokers, falls dieser ein Login erfordert. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| password | **Optional**: Password des MQTT Brokers, falls dieser ein Login erfordert. |
+-------------------------+------------------------------------------------------------------------------------------------------+

0 comments on commit 87acd50

Please sign in to comment.