HowTo: Zigbee – Administration of Zigbee2mqtt via the dashboard

Initially, Zigbee2mqtt could only be configured and controlled via the configuration file or access to the MQTT server.

In the meantime, however, there is a very useful extension for zigbee2mqtt that makes it possible to configure zigbee2mqtt via an integrated web server. This means you simply visit a website that can be reached via the same Raspberry Pi on which zigbee2mqtt is installed.

All configuration options are then made available there in a clear and elegant way. You no longer have to struggle through the configuration file and can configure everything conveniently from the browser.

I have summarized information on how to activate the dashboard of zigbee2mqtt and a brief overview of the functions in the following article.


Safety instructions

I know the following hints are always a bit annoying and seem unnecessary. But unfortunately, many people who knew it "better" from carelessness lost their eyes, fingers or other things or hurt themselves. In comparison, a loss of data is almost not worth mentioning, but even these can be really annoying. Therefore, please take five minutes to read the safety instructions. Even the coolest project is worth no injury or other annoyance. https://www.nerdiy.de/en/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 shop via this link, Nerdiy.de receives a commission from the online shop or provider concerned. The price doesn't change for you. If you do your purchases via these links, you will support Nerdiy.de in being able to offer further 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  Bei Amazon kaufen
1xSD card reader  Bei Amazon kaufen

Required material:

NumberLink
1xSONOFF Zigbee 3.0 USB Dongle Plus  Bei Amazon kaufen
1xUSB extension cable  Bei Amazon kaufen
1x Raspberry Pi  Bei Amazon kaufen
1x Raspberry Pi power supply  Bei Amazon kaufen
1x Raspberry Pi housing  Bei Amazon kaufen
1x Micro SD Card 64GB  Bei Amazon kaufen


Enable Zigbee2mqtt dashboard

By default, the zigbee2mqtt dashboard is not (yet) enabled.

To activate it, a simple entry in the zigbee2mqtt configuration file is enough.

To do this, open the configuration file with the following bash command.

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

Then use the arrow keys to navigate to the end of the configuration file and add the part below to the configuration file.

You should definitely change the password (auth_token). This will be needed later to open the dashboard.

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

You can find more information about the configuration options of the dashboard under the following link.


Open the Dashboard

The dashboard can be opened via a simple web browser. All you have to do is enter the address of the Raspberry Pi on which zigbee2mqtt is installed in the address bar of your browser. It is important that you add the port defined in the configuration file to the address.

For example, if the Raspberry Pi can be reached at the address “ADDRESS_OF_THE_PI” and the configured port is “8083”, you would reach the zigbee2mqtt dashboard at the following address.

  • http://ADDRESS_OF_THE_PI:8038/


Setting the language

The first setting you will probably want to change is the language of the dashboard.

You can set the dashboard to your desired language via a simple menu. Simply click on the flag symbol in the top menu bar of the dashboard and select your desired language.

View of the language selection menu on the dashboard home page.


Register new devices to zigbee2mqtt

You can also easily register new zigbee devices via the dashboard. In the past, the configuration file had to be changed or messages sent via MQTT.

The dashboard makes this process much easier. One click is enough and zigbee2mqtt allows you to add new Zigbee sensors or actuators.

How to add Zigbee devices I have also described in more detail in the following article.

To add new devices to zigbee2mqtt, just click on the button shown in the top menu bar.

It is then possible to add new Zigbee devices.

This permission is automatically deactivated after 255 seconds.


Display an overview of the devices registered to zigbee2mqtt

Now a few words about the individual menu items of the zigbe2mqtt dashboard.

In the upper menu bar you can see all devices registered to your zigbee2mqtt installation under the “Devices” tab. Here you can see the “Friendly Name”, the IEEE address, the manufacturer, the model, the signal strength and, if applicable, the charge level at a glance. The last icon also shows whether the respective device is powered by a battery or mains power.

Device overview view in zigbee2mqtt. All registered Zigbee devices are listed here.


Dashboard by zigbee2mqtt

The next tab in the Dashboard menu is the “Dashboard” tab. Most Zigbee devices are also listed here. The difference here is that the registered devices can also be controlled or read out.

For this purpose, the individual Zigbee devices are combined in tiles. Each tile represents a Zigbee device. The appearance of the tile varies depending on the device type.

Dashboard tab view in zigbee2mqtt tab.

On the left you can see the view of the dashboard tile for a Xiaomi Aqara MCCGQ11LM door or window sensor.

The following data can be viewed:

  1. friendly name
  2. First state name
  3. Second state name
  4. State of the first state
  5. State of the second state
  6. “Last seen” timestamp
  7. Reception strength Icon
  8. Reception strength in the value range 0-255 (bigger better)
  9. State of charge or type of supply

On the left you can see the view of the dashboard tile for an IKEA lamp LED1903C5/LED1835C6.

The following data can be viewed:

  1. Friendly name
  2. First state name
  3. Second state name
  4. Third state name
  5. State of the first state
  6. State of the second state
  7. State of the third state
  8. “Last seen” timestamp
  9. Reception strength Icon
  10. Reception strength in the value range 0-255 (bigger better)
  11. State of charge or type of supply


Display map / network map of the devices registered to zigbee2mqtt

A really cool feature to get an overview of the connected devices is the map tab.

In this not only all devices are shown. It is also visible how these are connected to each other. Some end devices are not always directly connected to the Zigbee USB dongle. Many mains powered devices also function as repeaters or routers for the Zigbee network. A terminal device can be indirectly connected to the Zigbee USB dongle via a router. Such a configuration is very visible using the map view.

In order for the network map to be displayed, you must first click on the “Load Map” button.

This retrieves the network configuration and displays it shortly thereafter.

In the loaded network map you can then see an overview of the connected Zigbee devices. The devices connected with blue lines are the different routers in the network. Various (mostly battery-powered) end devices are connected to it (via green lines).


Configure / set up Zigbee2Mqtt

Most of the settings for zigbee2mqtt are hidden behind the Settings tab.

You can configure most of the settings here without having to edit the zigbee2mqtt configuration file.

View of the Settings tab in the zigbee2mqtt dashboard.


Group devices together

Another useful function is hidden behind the Groups tab. Here you can group Zigbee devices together.

For example, two or more lamps can be grouped together and controlled centrally. Switching commands are thus forwarded in parallel to each lamp in the group. This is useful, for example, if you want to switch all the lamps in a chandelier at the same time.

View of the Group tab in the zigbee2mqtt dashboard.


Initiate an Over the Air (OTA) update

The OTA tab offers the possibility (if available) to run an over-the-air (OTA) update on the Zigbee devices.

So if new firmware is available for your Zigbee sensors or actuators, you can easily transfer it to the respective device with a simple click.

View of the OTA tab in zigbee2mqtt dashboard. Here you can see information about the available devices, their firmware status and whether an update is available. If an update is available, you can also run it from here.


Use Touchlink function with zigbee2mqtt

You can find the options for the Touchlink function in the Touchlink tab. This function is mainly known from IKEA Zigbee devices and is useful if you want to connect devices quickly and easily.

To do this, you have to activate the Touchlink function and hold the device to be connected close to the Zigbee base station (e.g. the Sonoff zigbee 3.0 USB Dongle Plus).

You can also find information on how to add devices to your Zigbee network in the following article.


Show the log of zigbee2mqtt

It is particularly useful to be able to display the log output of zigbee2mqtt for debugging and registering new Zigbee devices.

In the logs tab you can (depending on the log level set) see all status changes in zigbee2mqtt. With the help of simple filter options, you can also set which messages you want to see and according to which log level they should be filtered.

Viewing the messages in the zigbee2mqtt log tab.


Toggle theme between light and dark mode

With the sun or moon icon you can change the appearance of your zigbee2mqtt dashboard between dark and light design. Simply click on the icons marked in red and the design will be adjusted accordingly.

On the left you can see the “bright” view of the zigbee2mqtt dashboard.

By clicking on the sun in the red area you can switch the design to the dark design.

Here you can see the “dark” view of the zigbee2mqtt dashboard.

By clicking on the moon in the area marked in red, you can switch the design to the light design.


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 can be controlled from NodeRed.

In the following category I have also listed some Zigbee devices which can be controlled or read out with the NodeRed code offered there.


Have fun with the project

I hope everything worked as described. If not or you have any other questions or suggestions, please let me know in the comments. Also, ideas for new projects are always welcome. 🙂

P.S. 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 appreciate it that I share these information with you, I would be happy about a small donation to the coffee box. 🙂

Buy Me a Coffee at ko-fi.com   

4 comments

  1. Danke für die Artikelserie zu zigbee2mqtt. Habe diese Funktion bisher mit homegear realisiert und dann in NodeRED meine Verknüpfungen erstellt. Dies scheint mir aber deutlich komfortabler zu sein!

  2. Hallo, mein Name ist Dietmar,
    ich habe es versucht, und bis zum Dashboard klappt aus alles. Zigbee2mQtt hat auch den Test gut durchlaufen.
    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.
    Für Hilfe bin ich dankbar.
    Viele Grüße
    Dietmar

    1. Hi Dietmar,
      Kannst du mal prüfen ob du beim aufruf der Adresse auch den korrekten Port genutzt hast?
      Wenn du in der Konfiguration den Port 8080 eingestellt hast musst du das Dashboard wie folgt aufrufen: http://:ADRESSE_DES_PIS:8080
      Ich merke gerade, dass mein Beispiel dahingehend etwas irreführend ist. 🙂
      Beste Grüße
      Fabian

Leave a Reply

Your email address will not be published.