| Autor | |
|---|---|
| Logo |
|
| Status | RELEASE |
| Version | 1.0 |
| Min. LB Version | LB 1.4.0 |
| Download | Release: https://github.com/christianTF/LoxBerry-Plugin-MQTT-Gateway/archive/1.0.zip Pre-Release: - |
| Zweck | Installiert den MQTT-Broker Mosquitto und stellt ein MQTT-Gateway für den Miniserver bereit. |
| Languages | EN |
| Diskussion | https://www.loxforum.com/forum/projektforen/loxberry/plugins/176025-loxberry-mqtt |
Inhalt
Download
Der direkte Download des Releases befindet sich in der Tabelle oben.
Repository: https://github.com/christianTF/LoxBerry-Plugin-MQTT-Gateway
Kommunikationsdiagramm
(Anklicken zum Vergrößern)
Sieh dir links im Navigationsbaum weiterführende Artikel zu MQTT an, um die Funktionsweise besser zu verstehen.
Begriffserklärung
Ein "Broker" ist ein Dienst, der als Vermittler von Nachrichten dient. Der Broker speichert auch den aktuellen Zustand aller angeschlossenen Geräte. Das Plugin installiert automatisch am LoxBerry den Mosquitto MQTT Broker als Vermittler. Über die Konfiguration kann auch ein Broker auf einem anderen Server angegeben werden. Das Plugin unterstützt Authentifizierung, jedoch keine Verschlüsselung zum Broker.
Ein "Server" ist in der Begrifflichkeit von MQTT jedes Gerät, das Daten einliefert. Beispielsweise sind die Shelly's MQTT-Server, die Daten an den Broker übermitteln.
Ein "Client" ist jede Software, die sich mit dem Broker verbindet und dort Stati abfragt, Befehle sendet bzw. auf Statusänderungen lauscht. Dieses Plugin ist so ein Client, der zum Broker verbindet und sich Statusaktualisierungen abonniert (subscribed). Ist vom Client ein MQTT-Topic abonniert, werden Daten dieses Topics vom Broker an diesen Client zur Verarbeitung weitergeleitet.
Funktion des Plugins
Das Plugin installiert zuerst automatisch den Mosquitto MQTT Broker (Hostname "localhost"). Erfahrene Benutzer können auch eine Verbindung zu einem anderen Broker einrichten. Das Plugin unterstützt kein TLS zum MQTT-Broker.
Das Plugin fungiert dann als Client an diesem MQTT-Broker, und leitet MQTT-Nachrichten an den Miniserver weiter, sowie empfängt Nachrichten vom Miniserver und leitet diese an den MQTT-Broker. Über das Webinterface können Topics abonniert werden. Die abonnierten Topics werden wahlweise per UDP, oder per HTTP Webservice an den eingestellten Miniserver übermittelt.
Das Senden von Nachrichten vom Miniserver an MQTT geht am besten per UDP.
Schnell-Konfiguration am Beispiel eines Shelly 2
MQTT an Loxone Miniserver
Einstellungen
| Einstellung | Standard | Beschreibung |
|---|---|---|
| Miniserver | Erster Miniserver | Die abonnierten Daten werden an diesen Miniserver gesendet. |
| Miniserver-UDP-Port | 11883 | Ist UDP aktiviert, werden Nachrichten an diesen UDP-Port des Miniservers übermittelt. |
| Per REST Webservice übermitteln | Ressourcenschonender als UDP! Die Nachricht wird direkt per HTTP-REST Webservice an den Miniserver übertragen. Dafür müssen selbst entsprechende Virtuelle Eingänge mit exakt dem hier dokumentierten Namen verwendet werden. Das Plugin verwendet die Nachricht als Bezeichnung für den Eingang, wobei / in _ konvertiert werden: shellies/shelly-12345/relay/1 wird zu Schau ins Logfile, dort werden die Bezeichnungen angezeigt. | |
| Per UDP übermitteln | Nachrichtenformat (für die Befehlserkennung): MQTT: shellies/shelly-12345/relay/1=off (oder =0) Befehlserkennung: | |
| Booleans konvertieren | Ein | In MQTT werden häufig Strings bei der Nachricht verwendet, beispielsweise "off" oder "on". Das Plugin konvertiert als Booleans identifizierte Strings in die Werte 0 oder 1. Strings, die erkannt werden, siehe LoxBerry::System::is_enabled bzw. LoxBerry::System::is_disabled |
| JSON expandieren | Werden JSON-Daten übertragen, wird die JSON-Struktur expandiert und an den http-Namen angehängt. Topic/abcde={"action":"on","linkquality":39} wird zu Auch Objekte und Arrays in beliebiger Hierarchie werden aufgelöst. Am besten in der Incoming Overview anschauen, wie die Daten nach der Expandierung aussehen. | |
TAB Subscriptions Abonnierte Topics | Die Angabe erfolgt mit einer Zeile pro Topic. Die Topics müssen vom MQTT-Device dokumentiert sein. Eine # definiert dabei einen "Joker" (wie man sonst den * verwendet), z.B. shellies/# abonniert alle Meldungen innerhalb des Topics shellies/. Siehe unten die Kurzübersicht bekannter MQTT-Geräte und Topics. | |
TAB Conversions Eigene Wert-Zu-Text Konvertierung | Da der Miniserver keine Texte weiterverarbeiten kann, können eingehende Nachrichten von einem String zu einem Wert konvertiert werden. Beispiel:
Sendet ein Device Beispielsweise in einem Status-Baustein kann der Wert weiter verarbeitet werden. | |
TAB Incoming Overview Anzeige der übermittelten Daten | Hier werden die per HTTP und UDP übermittelten Daten angezeigt. Die Aktualisierung erfolgt automatisch im Sekundentakt, ohne dass ein Browser-Refresh notwendig ist. In diesem Fenster können mit Copy&Paste virtuelle Eingänge/Texteingänge, oder für UDP die entsprechenden Befehlserkennungen kopiert werden. |
Den Button zum Speichern ganz unten nicht vergessen. Die neue Konfiguration wird beim Speichern automatisch übernommen.
Siehe auch: MQTT - Schritt für Schritt: MQTT -> Loxone
Miniserver an MQTT
| Einstellung | Standard | Beschreibung |
|---|---|---|
| Gateway UDP IN-Port | 11884 | Eingangsport am LoxBerry für UDP-Nachrichten, die an MQTT-Geräte weitergeleitet werden. Folgende Befehle werden unterstützt:
Beispiel 1: |
Wenn der Miniserver neu startet, empfiehlt es sich, mittels der Loxone-Zeit "Startimpuls" ein reconnect per UDP-Nachricht an das Gateway zu übermitteln. Beispiel im "Siehe auch"-Link.
Siehe auch: MQTT - Schritt für Schritt: Loxone -> MQTT
MQTT Broker-Einstellungen
| Einstellung | Standard | Beschreibung |
|---|---|---|
| Lokalen Mosquitto-Broker verwenden | Ja | Ist dies aktiviert, prüft das Plugin beim Reboot, ob Mosquitto läuft, und startet diesen gegebenenfalls. Aktiv: Lokale Mosquitto-Inszanz wird vom Plugin verwaltet (inkl. Änderung von Benutzername und Passwort) |
| MQTT Broker Adresse | localhost | Hier kann der Hostname angegeben werden, mit dem das Gateway verbinden soll. Wird beim Hostnamen kein Port angegeben, wird der Standardport 1883 verwendet. Eine Portangabe erfolgt per hostname:port |
| MQTT Broker Benutzername | loxberry | Der automatisch installierte Mosquitto-Broker wird mit dem Benutzer loxberry und einem generierten Passwort installiert. Diese Informationen kannst du bei der Einrichtung von Devices von hier kopieren. Wenn du Benutzername und Kennwort nachträglich änderst, musst du das auch bei allen bereits konfigurierten Geräten machen! Leerer Benutzer und leeres Kennwort deaktivieren die Authentifizierung am lokalen Broker. Bei externen Brokern wird hier deren Benutzername und Kennwort eingegeben. |
| MQTT Broker Passwort | <generiert> |
Incoming Overview
In der "Incoming Overview" werden alle eingehenden Daten der letzten 24 Stunden angezeigt. Diese wurden - sofern das Caching die Daten nicht unterdrückt hat - so an den Miniserver weitergeleitet.
Die Übersicht wird automatisch aktualisiert. Wenn du Text markierst, wird die Aktualisierung unterdrückt, damit du Bezeichnungen mit der Zwischenablage kopieren kannst.
Show advanced table information
Damit werden zusätzliche Schaltflächen und Optionen angezeigt.
- Topic: Zeigt bei HTTP die originale Topic-Bezeichnung an, auch bei JSON-extrahierten Daten.
- Disable Cache: Dieser Wert übergeht das Caching von LoxBerry, und sendet den Wert immer, auch wenn er gleich bleibt.
- Reset after send: Nachdem der Wert gesendet wurde, wird automatisch eine 0 nachgesendet. Das eignet sich für Geräte (z.B. Taster), die lediglich einen Wert (Impuls) senden und dann auf diesem Wert "stehen bleiben". Ein weiterer Impuls würde verursachen, dass wieder der gleiche Wert gesendet würde, und der Miniserver erkennt keine Änderung.
- Lösch-Symbol: Damit wird der Wert am Broker gelöscht. Bitte beachte, dass in der Übersicht die Zeile erhalten bleibt, weil der Broker durch das Löschen keine Information an die Subscriber aussendet. Die Tabelle wird aktualisiert, wenn du in den "Settings" den Button "Save and Apply" drückst (dieser Knopf löst eine Neuverbindung zum Broker aus).
Bekannte MQTT-Geräte und Subscription-Topics
Liebe Plugin-Benutzer! Bitte pflegt diese Tabelle mit euren eingesetzten Geräten, MQTT-Infos und Links!
Die Liste ist jetzt in diesem Unter-Artikel: MQTT-Gateway - Bekannte MQTT-Geräte und Subscription-Topics
Weitere Hinweise
- Die Deinstallation des MQTT-Gateway Plugins deinstalliert den Mosquitto-Broker. Bei der Deinstallation werden die zuletzt verwendeten Mosquitto-Zugangsdaten als Benachrichtigung in die Plugin-Verwaltung gesendet.
Roadmap
- Fehlerkorrekturen
- Gateway: Eigenes Topic zur Steuerung des MS
- Healthstatus aller Verbindungen
- Notifications bei Verbindungsfehlern
Fragen stellen und Fehler melden
MQTT Gateway - Troubleshooting Guide
GitHub: https://github.com/christianTF/LoxBerry-Plugin-MQTT-Gateway/issues
Forum: https://www.loxforum.com/forum/projektforen/loxberry/plugins/176025-loxberry-mqtt
Fehlerbeschreibungen
Für jeglichen Kontakt bzw. Probleme immer mitliefern:
- das Logfile
- die MQTT-Spezifikation des angebundenen Devices (z.B. direkter Link zur MQTT-Dokumentation des Geräts)
- Screenshots bzw. Beschreibung der durchgeführten Einstellungen usw.
Known Issues
- Beim Update des Plugins und Verwendung eines externen Brokers wird das Passwort auf ein generiertes Passwort gesetzt
Siehe auch
- Einrichtung am MQTT-Device
- HTTP-Eingänge am Miniserver debuggen
- MQTT Gateway - Alle FHEM-Readings weitergeben
- MQTT-Gateway - Bekannte MQTT-Geräte und Subscription-Topics
- MQTT Gateway for plugin developers
- MQTT-Gateway - Generischer POST / GET / JSON Empfänger
- MQTT Gateway - HTTP- und UDP-Interface
- MQTT Gateway - Konfiguration sichern und auf anderem/neuen LoxBerry wiederherstellen
- MQTT Gateway - Subscriptions und Topics
- MQTT Gateway - Troubleshooting Guide
- MQTT - Schritt für Schritt: Loxone -> MQTT
- MQTT - Schritt für Schritt: MQTT -> Loxone
- Was ist MQTT? Warum MQTT?
- Informationen und Best Practices zu Topics und Subscrictions: https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/
- Miele Home MQTT Gateway: https://www.loxforum.com/forum/projektforen/loxberry/plugins/176967-miele-mqtt-loxberry-mqtt
- Verschiedene MQTT-Interfaces von Devices und Diensten: https://github.com/hobbyquaker/awesome-mqtt#interfaces
- Fronius Hybrid und go-eCharger Bridge: https://github.com/akleber/mqtt-connectors
23 Comments
Alex
I need to integrate XIAOMI (Aqara) devices into LOXONE ZigBee.
I have already done the integration of these products through ESP8266 (WittyCloud) over UDP, but using DGNWG02LM. Now I want to get rid of DGNWG02LM.
As a gateway, it is planned to use the MQTT Gateway plugin for Loxberry.
There is CC2531, which I successfully uploaded zigbee2mqtt firmware. To test CC2531 on Raspberry Pi 3B , I installed Rasbian Buster Lite and connected WSDCGQ11LM and WXKG02LM. Everything works great.
When I installed the MQTT Gateway plugin on Loxberry, I ran into a problem. My Aqara devices are not detected.
Help solve this problem. The information in the documentation and on the forum was not enough for me.
Christian Fenzl
Could you post all information you have to a thread in loxforum / LoxBerry Plugins area. Include all output, settings, docu (or docu links).
Sebastian Loidolt
Hallo, ich habe alles soweit sogut installiert, Habe auch eine Tasmota Steckdose, welche Einwandfrei per UDP funktioniert im Einsatz. Nun hab ich mir folgendes Thermostat geholt und geflashed. https://github.com/klausahrenberg/ThermostatBecaWifi
Ich schaffe es die Werte in die Loxone einzulesen und auch via Loxone am MQTT Broker zurückzuschreiben. (Temperatur). jedoch habe ich folgendes Problem. Wenn ich die Temperatur am Thermostat ändere, funktioniert das ohne Probleme in der Loxone. Wenn ich jedoch die Temperatur in der Loxone ändere damit es aufs Thermostat übertragen wird, gelangt es nur zum Broker und nicht auf das Thermostat. D.h. nach spätestens 5 Minuten ist wieder der Wert vom Thermostat eingestellt. Hat jemand eine Idee oder Lösung?
mit freundlichen Grüßen
Sebastian Loidolt
Habe es lösen können.
Christian Fenzl
Interessantes Gerät!
marco pichler
Hallo, ich habe Tasmota 7.1.2 auf ein ESP8266 gespielt.
Nun versuche ich es mit dem MQTT-Gateway am Loxberry zu "verbinden" - schaffe es aber leider nicht.
Beim MQTT-Plugin unter "incoming overview" erscheinen kein zusätzlichen entries.
(habe bereits ein paar shellies erfolgreich verbunden)
Hat jemand eine Idee oder Lösung?
mit freundlichen Grüßen
MQTT2.PNG
MQTT1.PNG
MQTT.PNG
Christian Fenzl
Hat du sonoff/# in der Subscription?
marco pichler
Danke!!! das wars!
AlexAn
Hab es hier beschrieben: ESP8266-01 mit Tasmota Sonoff
dmitry karageur
Hello! How to add broker made on Node.js ?
I need to control several Gree Air Conditioners by mqtt using this broker - link:
https://github.com/arthurkrupa/gree-hvac-mqtt-bridge
Christian Fenzl
This is not an MQTT Broker, but an MQTT Client.
Just set the start options of the node.js program to connect to LoxBerry (user, pass from MQTT Gateway Settings screen) and add a subscription (e.g.
home/greehvac/#) in the MQTT Gateway.dmitry karageur
I apologize for dump question but do I need separate device for this? or I can run LoxBerry and node.js on a same raspberry pi?
Christian Fenzl
Node.js V12 LTS is included in LoxBerry 2.0+.
Below LB2, you‘ll need to install Node.js by your own.
dmitry karageur
I made mqtt on Loxberry communicate with AirConditioner and it's being controlled.
Please explain how can I automate the process of initiation when Loxberry starts - for communication to begin I must pass this command at once in ssh console.
And what shall I do if I have several AirConditioners - so I have to pass different commands of initiation.
Thank you!
node gree/index.js \
--hvac-host="192.168.1.123" \
--mqtt-broker-url="mqtt://192.168.1.105" \
--mqtt-topic-prefix="home/greehvac" \
--mqtt-username="mqtt" \
--mqtt-password="mqtt"
Christian Fenzl
You can create a cron job for this: Create own cronjob on LoxBerry
On LoxBerry 2.x, use the "Using LoxBerry's own schedules" way by using the cron.reboot folder. Create a file
hvac-host1(without extension) and put this command into it. Into the first line, put#!/usr/bin/bashinto it (as explained in the article).For multiple Air Conditions simply create multiple files with different hvac-host.
For further questions, it's better to ask directly in this loxforum.com Thread, as I don't monitor LoxWiki comments regularly: https://www.loxforum.com/forum/projektforen/loxberry/plugins/176025-loxberry-mqtt
dmitry karageur
Thank you! I just saw your message but I handled it myself very similar to your solution.
I made for each air conditioner it's index.js with parameters set inside it (ip host, mqtt server, login, pass, and prefix), then I made bash script with pm2 node process manager that starts each instance of node.js separately. I recall each AC with unique prefix name.
Robert Kolar
hallo! ich versuche meine wärempumpe von vaillant mittels ebusd ins system zu übernehmen.
das klappt auch alles super bis auf einige werte die er mir vom raspi überträgt sobald ich sie dort abfrage.
was muss ich da setzen um bestimme befehle abzufragen?
ebusd/# liefert mir viele werte aber nicht alle
lauf john von ebusd muss ich ein get am ende setzen aber das liefert mir dann garkeine werte mehr.
wenn ich es einzeln abfrage kommt auch keine antwort.
ebusd/700/# liefert auch keine werte obwohl es zb den wert ebusd/700/HwcStorageTemp gibt sobald man den extern im raspi anfragt.
geht das mit der software selber oder muss man da ein extra script verwenden?
Christian Fenzl
Zur Referenz, worum es geht: https://github.com/john30/ebusd/wiki/3.3.-MQTT-client
Wie ich das verstehe: Du machst erst mal eine Subscription auf ebusd/# und bekommst alles, was ebusd aktiv published.
Damit ebusd nicht gesendete Werte nachliefert, musst du aktiv eine MQTT-Message an ebusd senden, das geht so: MQTT - Schritt für Schritt: Loxone -> MQTT
Beispielsweise probiere mal vom Miniserver aus (im Virtuellen Ausgangs-Befehl) Folgendes an das MQTT Gateway zu senden:
publish ebusd/700/get
Zum Testen kannst du auch die Shell verwenden:
mosquitto_pub -u loxberry -P <password> -t "ebusd/700/get" -m ""
oder eventuell
mosquitto_pub -u loxberry -P <password> -t "ebusd/700/get" -n
Robert Kolar
danke sehr. werde ich heute mal austesten.
muss ich UDP verwenden um das umsetzten zu können oder klappt das auch mit HTTP mit der aktuellen version?
Robert Kolar
bin einen schritt weiter (hoffe ich zumindest)
mit dem befehl http:iploxberry/admin/plugins/mqttgateway/mqtt.php?topic=ebusd/list bekomme ich alle werte die es gibt.
diese sind jedoch leider alle 0 zumindest die neuen die nicht nicht automatisch abgefragt wurden.
topic: ebusd/list value: retain:
ebusd/list
36 bytes written to udp address udp://127.0.0.1:11884
wie kann ich bestimmte werte gezielt abfragen inkl. deren wert?
kann man mit http überhaupt werte setzen oder muss das alles in udp gemacht werden?
das mit dem virtuellen ausgang auf dem miniserver habe ich probiert - sind aber keine werte angekommen ...
Christian Fenzl
Bezüglich Loxone→MQTT: Du kannst sowohl das mqtt.php als auch UDP verwenden. UDP ist schneller. Wenn du mqtt.php verwendest, sendet dieses selbst als UDP weiter (wie du im Response gesehen hast). Werte setzen kannst du mit beiden Interfaces.
Ich kenne ebusd selbst nicht. Ich lese, dass es da auch noch irgendwelche "Message Poll" Prioritäten gibt. In der ebusd Hilfe ist auch ein Beispiel mit get. Vielleicht musst du gezielt angeben, was du abrufen möchtest (keine Ahnung, z.B. ebusd/700/meinWert/get ).
Ich möchte vorschlagen, dass du die Diskussion ins LoxForum verlegst (mach einen neuen Thread im LoxBerry-Plugins Bereich auf) - hier ist nicht als Forum gedacht. Häng dort auch ein paar Screenshots an, dann sieht man mal, was du womit zurückbekommst.
lg, Christian
Robert Kolar
super - danke! werde ich machen sobald ich zeit habe. mir es es leider nicht gelungen einen befehl abzufragen sondern nur einen zu setzen. auch aus den bekannten werten im mqtt habe ich keinen wert über den browser erhalten. beim nuki zb.: reicht mit die eingabe des namen alleine im loxone und er holt sich die werte ...
Aleš Berka
Amazing plugin, great job. Thank you!