HowTo: ESPEasy – MQTT-Server konfigurieren und Topics abonnieren

Öffnet zunächst du Konfigurationswebseite Eures mit ESPEasy programmierten ESP8266, indem Ihr dessen IP-Adresse in Euren Webbrowser eingebt. Infos dazu wie Ihr die IP-Adresse herausfinden könnt, sind auch im Artikel IP-Adresse der Geräte im Netzwerk anzeigen/herausfinden zusammengefasst.

Sobald Ihr die Konfigurationswebseite geöffnet habt, müsst Ihr auf den “Controllers”-Tab wechseln. Klickt dazu auf den “Controllers”-Button.

Klickt nun auf den “Add”-Button in einer der noch leeren Zeilen.

Dadurch werdet Ihr auf eine Seite weitergeleitet, auf der ein Drop-Down-Menü dargestellt wird.

Öffnet das Drop-Down-Menü indem Ihr darauf klickt und wählt den Eintrag “Home Assistant (openHAB) MQTT” aus.

Daraufhin werdet Ihr zur Konfigurations-Seite dieses Controllers (=MQTT Server) weitergeleitet. Als erstes könnt Ihr hier auswählen ob Ihr die Adresse des MQTT-Servers als Hostname oder IP-Adresse angeben wollt.

In dem hier gezeigten Beispiel verwende ich einen Hostnamen. Ihr könnt aber auch eine IP-Adresse verwenden. Wenn Ihr das tut solltet Ihr Euren Router aber so konfigurieren, dass die IP-Adresse fest eingestellt ist.

Die weiteren Einstellungen könnt Ihr wie abgebildet übernehmen.

Wichtig ist, dass der Port auf dem konfigurierten Port Eures MQTT Servers (standardmäßig 1883) eingestellt ist.

Außerdem müsst Ihr die Logindaten zu Eurem MQTT-Server angeben, wenn dieser eine Authentifizierung erfordert. Tragt dazu Benutzername und Passwort in die entsprechenden Felder ein und setzt den Haken bei “Use Extended Credentials”.

Die restlichen Einstellungen könnt Ihr wie abgebildet konfigurieren. Der Vollständigkeit halber im folgenden trotzdem eine kleine Beschreibung.

• “Controller Client ID”: Hier könnt Ihr den Namen/ID Eures Controllers gegenüber dem MQTT Server festlegen.
• “Unique Client ID on Reconnect”: Ist dieser Haken gesetzt wird bei einem neuen verbindungsversuch eine zufällige ID angehängt. Dies verhindert (sehr wahrscheinlich), dass zwei Clienten mit der gleichen ID verbunden sind.
• “Publish Retain Flag”: Ist dieser Haken aktiviert werden veröffentlichte Werte inkl. “Retain Flag” gesendet.
• “Controller Subscribe”: Dieses Topic wird vom Controller aboniert. Über dieses Topic können dann zum Beispiel Befehle an ESPEasy gesendet werden. Informationen dazu findet Ihr auch im Artikel ESPEasy – Befehle und Aktionen per HTTP, MQTT, UDP und direkt ausführen.
• “Controller Publish”: Hier wird das Topic festgelegt unter dem Sensorwerte (falls aktiviert) veröffentlicht werden.
• “Controller LWT Topic”: Über das LWT(=”Last Will/Testament”) kann der MQTT-Server über den Verbindungsstatus des Clienten berichten.
• “LWT Connect / Disconnect Message”: Mithilfe dieser Option kann die Nachricht festgelegt werden, welche über das LWT Topic im Verbindungsfall oder bei Verbindungsabbruch gesendet wird.
• “Send LWT to broker”: Aktiviert/Deaktiviert die LWT-Funktionalität
• “Will Retain”: Setzt das “Retain Flag” für die über das LWT Topic versendeten Nachrichten.
• “Clean Session”: Aktiviert / Deaktiviert eine Anmeldung einer “sauberen Sitzung”
• “Enabled”: Aktiviert / Deaktiviert diesen Controller

Sobald Ihr alle Einstellungen nach Euren Wünschen konfiguriert habt, könnt Ihr die Einstellungen durch einen Klick auf “Submit” übernehmen.

Danach sollte Euer Controller in der Controller-Übersicht aufgeführt werden.

Falls Ihr mehr als einen Controller konfiguriert habt, solltet Ihr Euch die Zahl der Teile merken in welcher der MQTT-Server konfiguriert ist. In diesem Beispiel ist der MQTT-Server der erste Controller.

Wechselt dazu zunächst in den “Devices”-Tab indem Ihr auf den “Devices”-Button klickt.

Falls nicht schon geschehen müsst Ihr dazu zunächst einen Sensor konfigurieren.

In diesem Beispiel wird der DHT11 verwendet.

Klickt dazu im “Devices”-Tab auf den “Add”-Button in der ersten leeren Zeile.

Konfiguriert dann die Option für “GPIO Data” und “Sensor model” Eurem Sensor entsprechend.

Nun aber zum MQTT-Teil:
Damit ESPEasy die Sensordaten an den MQTT-Server sendet müsst Ihr den Haken im Abschnitt “Send to Controller” aktivieren. Da Ihr die Daten an den ersten Controller senden wollt ist der Haken neben der “1” aufgeführt.

Mithilfe der “Interval”-Option könnt Ihr festlegen wie oft der Sensor ausgelesen wird. Die Daten werden dann im gleichen Intervall versendet. Im dargestellten Beispiel wird der Sensorwert also jede Sekunde ausgelesen und über MQTT versendet.

Speichert diese Einstellungen wieder durch einen Klick auf “Submit”.

Zurück im “Devices”-Tab könnt Ihr nun auch den eingetragenen Controller sehen.

Mithilfe eines externen MQTT Clienten lässt sich dann auch prüfen, ob die Daten versendet werden.

Im Bild seht Ihr einen Ausschnitt aus der Ansicht des “MQTT Explorer”. Dieses Tool ist kostenlos und ist sehr hilfreich beim Umgang mit MQTT Botschaften.

Wechselt dazu wieder in den “Devices”-Tab indem Ihr auf den “Devices”-Button klickt.

Klickt dann auf den “Add”-Button in der ersten leeren Zeile.

Daraufhin werdet Ihr wieder zu einem DropDown-Menü weitergeleitet. Wählt hier den Eintrag “Generic – MQTT Import” aus.

In dem dann dargestellten Menü könnt Ihr bis zu vier Topics abonnieren. Tragt diese dazu unter “MQTT Topic 1 – 4” ein.

Im Abschnitt “Values” könnt Ihr dann noch die Namen der Variablen festlegen. Diese Variablen beinhalten später die über MQTT empfangenen Werte. Dies ist zum Beispiel wichtig, wenn Ihr mithilfe von “Rules” auf diese Werte reagieren wollt.

Wen Ihr alles wie gewünscht konfiguriert habt prüft nochmal, dass Ihr den Haken bei “Enabled” gesetzt habt und bestätigt die Einstellungen durch einen Klick auf “Submit”.

Nun könnt Ihr mithilfe von Regeln auf die abonierten Topics reagieren. Dazu müsst Ihr zunächst in den “Rules”-Tab wechseln.

Wenn dieser nicht sichtbar ist, müsst Ihr ihn zunächst aktivieren.

Klickt dazu auf “Tools” um zum “Tools”-Tab zu wechseln.

Klickt dort auf “Advanced”…

…und setzt einen Haken bei der Option “Rules”.

Bestätigt diese Einstellung dann durch einen Klick auf den “Submit”-Button.

Nun sollte der “Rules”-Tab sichtbar sein.

Falls nicht sollte er spätestens nach einem “Reload” der Seite sichtbar werden.

On MQTT#Value_of_TestTopic1 do
if [MQTT#Value_of_TestTopic1]=1.00
pbani,5,150,0,0,0,0,0,
endif
endon

Im “Rules”-Tab könnt Ihr dann zum Beispiel die dargestellten Regeln eintragen. Diese bewirken, dass jedes Mal, wenn über das Topic “Value_of_TestTopic1” eine eins empfangen wird, der Befehl “pbani,5,150,0,0,0,0,0,” ausgeführt wird.

Dieser Befehl ist Teil des pxlBlck-Plugins. Informationen dazu findet Ihr auch hier pxlBlck – Befehle zur Konfiguration des pxlBlck