HowTo: Zigbee - Administration of Zigbee2mqtt via Dashboard

Zigbee2mqtt ließ sich anfangs nur über die Konfigurationsdatei oder Zugriff auf den MQTT-Server konfigurieren und steuern.

Mittlerweile gibt es aber eine sehr nützliche Erweiterung für cigbee2mqtt die es möglich macht zigbee2mqtt über einen integrierten Webserver zu konfigurieren. Das heißt man besucht einfach eine Webseite, die über den selben Raspberry Pi erreichbar ist, auf dem auch zigbee2mqtt installiert ist.

Dort werden dann alle Konfigurationsoptionen übersichtlich und recht schick zur Verfügung gestellt. Man muss sich also nicht mehr durch die Konfigurationsdatei quälen und kann alles bequem aus dem Browser konfigurieren.

Hinweise dazu wie Ihr das Dashboard von zigbee2mqtt aktiviert und eine kurze Übersicht über die Funktionen habe ich im folgenden Artikel zusammengefasst.


Safety instructions

I know the following notes are always kind of annoying and seem unnecessary. Unfortunately, many people who knew "better" have lost eyes, fingers or other things due to carelessness or injured themselves. Data loss is almost negligible in comparison, but even these can be really annoying. Therefore, please take five minutes to read the safety instructions. Because even the coolest project is not worth injury or other trouble.
https://www.nerdiy.de/sicherheitshinweise/

Affiliate links/advertising links

The links to online shops listed here are so-called affiliate links. If you click on such an affiliate link and make a purchase via this link, Nerdiy.de will receive a commission from the relevant online shop or provider. The price does not change for you. If you make your purchases via these links, you support Nerdiy.de in being able to offer other useful projects in the future. 🙂 


Requirements

Helpful articles:
Before you start with this article, you should have prepared a RaspberryPi so that it can be reached via the network and controlled via SSH. In addition, zigbee2mqtt should of course already be installed.

The following articles describe what needs to be done to prepare the RaspberryPi.

In the following lists you will find all the parts you need to implement this article.

Required tool:

NumberLink
1xScrewdriver set  Buy at Amazon
1xSD card reader  Buy at Amazon

Required material:

NumberLink
1xSONOFF Zigbee 3.0 USB Dongle Plus  Buy at Amazon
1xUSB extension cable  Buy at Amazon
1x Raspberry Pi  Buy at Amazon
1x Raspberry Pi power supply  Buy at Amazon
1x Raspberry Pi case  Buy at Amazon
1x Micro SD card 64GB  Buy at Amazon


Enable Zigbee2mqtt Dashboard

Standardmäßig ist das Dashboard von zigbee2mqtt (noch) nicht aktiviert.

Um es zu aktivieren reicht ein einfacher Eintrag in der Konfigurationsdatei von zigbee2mqtt.

Öffnet dazu die Konfigurationsdatei mit dem folgenden bash Befehl.

sudo nano /opt/zigbee2mqtt/data/configuration.yaml

Navigiert dann mit den Pfeiltasten bis zum Ende der Konfigurationsdatei und fügt dort den unten stehenden Teil in die Konfigurationsdatei ein.

Dabei solltet Ihr unbedingt das Passwort (auth_token) anpassen. Dies wird später benötigt um das Dashboard zu öffnen.

frontend: port: 8080 host: 0.0.0.0 auth_token: secretPassword url: https://url.org

Weitere Infos zu den Konfigurationsoptionen des Dashboard findet ihr auch unter folgendem Link.


Dashboard aufrufen

Das Dashboard kann über einen einfachen Webbrowser geöffnet werden. Dazu müsst Ihr lediglich die Adresse des Raspberry Pi auf dem zigbee2mqtt installiert ist in der Adresszeile Eures Browser eingeben. Wichtig dabei ist, dass Ihr die Adresse um den in der Konfigurationsdatei definierten Port ergänzt.

Wenn der Raspberry Pi zum Beispiel unter er Adresse “ADRESSE_DES_PIS” erreichbar ist und der konfigurierte Port “8083” lautet, so würdet Ihr das zigbee2mqtt Dashboard unter folgender Adresse erreichen.

  • http:// ADRESSE_DES_PIS :8038/


Sprache einstellen

Die erste Einstellung die Ihr vermutlich verändern wollt ist die Sprache des Dashboards.

Über ein einfaches Menü könnt Ihr das Dashboard nämlich auf Eure gewünschte Sprache einstellen. Klickt dazu einfach auf das Flaggensymbol in der oberen Menüleiste des Dashboards und wählt Eure gewünschte Sprache aus.

Ansicht des Sprach-Auswahlmenüs auf der Dashboard-Startseite.


Neue Geräte an zigbee2mqtt anmelden

Über das Dashboard könnt Ihr auch sehr leicht neue zigbee Geräte anmelden. Früher musste dazu die Konfigurationsdatei verändert oder Nachrichten über MQTT versendet werden.

Über das Dashboard ist dieser Vorgang erheblich erleichtert. Hier reicht ein Klick und zigbee2mqtt erlaubt das hinzufügen neuer Zigbee-Sensoren bzw. Aktoren.

Wie man Zigbee-Geräte hinzufügt habe ich etwas ausführlicher auch im folgenden Artikel beschrieben.

Um neue Geräte zu zigbee2mqtt hinzufügen zu können reicht ein Klick auf den gezeigten Button in der oberen Menüleiste.

Daraufhin ist es möglich neue Zigbee-Geräte hinzuzufügen.

Diese Erlaubnis wird automatisch nach Ablauf von 255 Sekunden wieder deaktiviert.


Übersicht der an zigbee2mqtt angemeldeten Geräte anzeigen

Nun ein paar Worte zu den einzelnen Menüpunkten des zigbe2mqtt Dashboard.

In der oberen Menüleiste könnt Ihr unter dem Reiter “Devices” alle an Eure zigbee2mqtt Installation angemeldete Geräte einsehen. Hier ist auf einem Blick der “Friendly Name”, die IEEE Adresse, der Hersteller, das Modell, die Signalstärke und ggf. der Ladezustand zu sehen. Über das letzte Icon wird außerdem angezeigt ob das jeweilige Gerät von einer Batterie oder Netzstrom versorgt wird.

Ansicht der Geräteübersicht in zigbee2mqtt. Hier werden alle angemeldeten Zigbee-Geräte aufgelistet.


Dashboard von zigbee2mqtt

Der nächste Reiter im Menü des Dashboard ist der “Dashboard”-Reiter. Hier werden ebenfalls die meisten Zigbee-Geräte aufgelistet. Der Unterschied hier ist, dass die angemeldeten Geräte auch gesteuert bzw. ausgelesen werden können.

Dazu sind die einzelnen Zigbee-Geräte in Kacheln zusammengefasst. Jede Kachel steht dabei für ein Zigbee-Gerät. Dabei ist das Aussehen der Kachel je nach Geräteart unterschiedlich.

Ansicht des Dashboard-Reiter im zigbee2mqtt Reiter.

Links seht Ihr die Ansicht der Dashboard-Kachel für einen Xiaomi Aqara MCCGQ11LM door or window sensor.

Dabei sind die folgenden Daten einsehbar:

  1. Friendly Name
  2. Name des ersten Status
  3. Name des zweiten Status
  4. Zustand des ersten Status
  5. Zustand des zweiten Status
  6. “Last seen”-Zeitstempel
  7. Empfangsstärke-Icon
  8. Empfangsstärke im Wertebereich 0-255 (größer besser)
  9. Ladezustand bzw. Versorgungsart

Links seht Ihr die Ansicht der Dashboard-Kachel für eine IKEA Lampe LED1903C5/LED1835C6.

Dabei sind die folgenden Daten einsehbar:

  1. Friendly Name
  2. Name des ersten Status
  3. Name des zweiten Status
  4. Name des dritten Status
  5. Zustand des ersten Status
  6. Zustand des zweiten Status
  7. Zustand des dritten Status
  8. “Last seen”-Zeitstempel
  9. Empfangsstärke-Icon
  10. Empfangsstärke im Wertebereich 0-255 (größer besser)
  11. Ladezustand bzw. Versorgungsart


Karte / Networkmap der an zigbee2mqtt angemeldeten Geräte anzeigen

Eine wirklich coole Funktion um einen Überblick über die verbundenen Geräte zu bekommen ist der Map-Reiter.

In diesem werden nicht nur alle Geräte gezeigt. Es ist auch sichtbar wie diese untereinander verbunden sind. Manche Endgeräte sind nämlich nicht immer direkt mit dem Zigbee-USB-Dongle verbunden. Viele Netzstrombetriebene Geräte fungieren nämlich auch als Repeater bzw. Router für das Zigbee Netzwerk. So kann ein Endgerät indirekt über einen Router mit dem Zigbee-USB-Dongle verbunden sein. So eine Konfiguration wird mithilfe der Map-Ansicht sehr gut sichtbar.

Damit die Network-Map angezeigt wird müsst Ihr zunächst auf den “Load Map”-Button klicken.

Dadurch wird die Netzwerk-Konfiguration abgerufen und kurz darauf angezeigt.

In der geladenen Netzwerk-Map könnt Ihr dann die Übersicht über die verbundenen Zigbee-Geräte sehen. Die mit blauen Linien verbundenen Geräte sind dabei die verschiedenen Router im Netzwerk. Daran angebunden sind (über Grüne Linien) verschiedene (meist Batteriebetriebene) Endgeräte.


Zigbee2Mqtt konfigurieren / einstellen

Hinter dem Settings-Reiter verbergen sich die meisten Einstellungen für zigbee2mqtt.

Die meisten Einstellungen könnt Ihr also hier konfigurieren ohne die Konfigurationsdatei von zigbee2mqtt bearbeiten zu müssen.

Ansicht des Settings-Reiter im Dashboard von zigbee2mqtt.


Geräte als Gruppe zusammenfassen

Eine andere hilfreiche Funktion verbirgt sich hinter dem Groups-Reiter. Hier könnt Ihr nämlich Zigbee-Geräte in Gruppen zusammenfassen.

So lassen sich zum Beispiel zwei oder mehr Lampen zu einer Gruppe zusammenfassen und zentral steuern. Schaltbefehle werden so zu jeder Lampe der Gruppe parallel weitergeleitet. Dies ist zum Beispiel dann praktisch, wenn Ihr alle Lampen in einem Kronleuchter gleichzeitig schalten wollt.

Ansicht des Group-Reiter im Dashboard von zigbee2mqtt.


Over the Air (OTA) Update anstoßen

Der OTA-Reiter bietet die Möglichkeit (wenn verfügbar) ein Over-the-Air (OTA) Update auf den Zigbee-Geräten auszuführen.

Falls also eine neue Firmware für Eure Zigbee-Sensoren bzw. Aktoren verfügbar ist, könnt Ihr diese sehr leicht mithilfe eines einfachen Klicks auf das jeweilige Gerät übertragen.

Ansicht des OTA-Reiter im Dashboard von zigbee2mqtt. Hier seht Ihr Infos zu den verfügbaren Geräten, deren Firmware Status und ob ein Update verfügbar ist. Falls ein Update verfügbar ist könnt Ihr dies von hier aus auch ausführen.


Touchlink Funktion mit zigbee2mqtt nutzen

Die Optionen für die Touchlink-Funktion findet Ihr im Touchlink-Reiter. Diese Funktion ist vor allem von IKEA Zigbee-Geräten bekannt und ist praktisch, wenn Ihr Geräte einfach und schnell koppeln wollt.

Dazu müsst Ihr die Touchlink-Funktion aktivieren und das zu verbindende Gerät nah an die Zigbee-Basisstation (zum Beispiel der Sonoff zigbee 3.0 USB Dongle Plus) halten.

Hinweise wie Ihr Geräte zu Eurem Zigbee-Netzwerk hinzufügen könnt findet Ihr auch in dem folgenden Artikel.


Log von zigbee2mqtt anzeigen

Besonders zum debuggen und zum anmelden neuer Zigbee-Geräte ist es praktisch die Log-Ausgabe von zigbee2mqtt anzeigen zu können.

In dem Logs-Reiter könnt Ihr (je nach eingestelltem Log level) alle Status Änderungen in zigbee2mqtt sehen.
Mithilfe von einfachen Filtermöglichkeiten könnt Ihr hier auch noch einstellen welche Nachrichten ihr sehen wollt und auch nach welchem log level diese gefiltert werden sollen.

Ansicht der Nachrichten im Log-Reiter von zigbee2mqtt.


Design zwischen Hellem und dunklem Modus umschalten

Mit dem Sonnen- bzw. Mond-Icon könnt Ihr das aussehen Eures zigbee2mqtt Dashboards zwischen dunklem und hellem design wechseln. Klickt dazu einfach auf die rot markierten Icons und das Design wird entsprechend angepasst.

Links seht ihr die “helle” Ansicht des Dashboards von zigbee2mqtt.

Durch einen Klick auf die Sonne im rot markierten Bereich könnt Ihr das Design zum dunklen Design umschalten.

Hier seht ihr die “dunkle” Ansicht des Dashboards von zigbee2mqtt.

Durch einen Klick auf den Mond im rot markierten Bereich könnt Ihr das Design zum hellen Design umschalten.


More articles on the topic

I have summarized other articles on the subject of Zigbee and zigbee2mqtt in the following category. There you will also find articles on various Zigbee devices and how they look like NodeRed can be controlled.

In der folgenden Kategorie habe ich außerdem einige Zigbee-Geräte aufgelistet welche sich mit dem dort angebotenen NodeRed code ansteuern bzw. auslesen lassen.


Have fun with the project

I hope everything worked as described for you. If not or you have questions or suggestions please let me know in the comments. I will then add this to the article if necessary.
Ideas for new projects are always welcome. 🙂

PS Many of these projects - especially the hardware projects - cost a lot of time and money. Of course I do this because I enjoy it, but if you think it's cool that I share the information with you, I would be happy about a small donation to the coffee fund. 🙂

Buy Me a Coffee at ko-fi.com       

6 comments

  1. Thanks for the series of articles on zigbee2mqtt. So far I have implemented this function with homegear and then created my shortcuts in NodeRED. This seems to me to be much more comfortable!

  2. Hello, my name is Dietmar,
    I tried it and everything works up to the dashboard. Zigbee2mQtt also passed the test well.
    Allerding kann ich das Dashbord nicht aufrufen. Ich habe die Einträge in die “configuration” Datei vorgenommen, aber wenn ich versuche, von außen zuzugreifen, dann bekomme ich die Meldung, die Seite sei nicht erreichbar. Wo habe ich was vergessen? Hat der Stick eine eigene Adresse? Wohl eher ich.
    I'm thankful for any help.
    Best regards
    Dietmar

    1. Hi Dietmar,
      Can you check if you used the correct port when calling the address?
      If you have set port 8080 in the configuration, you must call up the dashboard as follows: http://:ADRESSE_DES_PIS:8080
      I just realized that my example is a bit misleading in that regard. 🙂
      Best regards
      Fabian

      1. Hello Fabian,
        many thanks for the quick response.
        Yes, I entered the port, even set the port explicitly in the router for the Raspi as a test.
        But didn't bring anything.
        So as I said, Zigbee2mqtt passed the test well.
        Best regards
        Dietmar
        PS: Under ADRESSE_DES_PIS I enter the address XXX.XXX.XXX.YYY

  3. Hello Dietmar,
    SUPER summary !! Do you maybe have an idea how to group and then control radiator thermostatic valves? (I manage grouping myself - in my case with several HAMA/Saswell valves) BUT how do you control the whole thing?? I can create scenes via the WebGui - but somehow they have no function whatsoever, or the setting of the individual valves does not change when called up via the WebGui). It gets even more obscure when I then want to control the group in DOMOTIZ - it's all just a simple switch.

Kommentar hinterlassen

Your email address will not be published. Erforderliche Felder sind mit * markiert

This site uses Akismet to reduce spam. Learn how your comment data is processed.