FYI: (Kurz)Anleitung zur Einrichtung von HA Mosquitto broker Addon + HA MQTT Integration + Z2M (Update: Bitte auch mein Posting vom 15.04.2026 beachten da es Änderungen bei Z2M gab)

Moin zusammen

Ergänzend zu meiner (Kurz)Anleitung zu dem Z2M Onboarding-Prozess und weil es ja auch User gibt die Schwierigkeiten haben einen MQTT Broker unter HA einzurichten, hier dann noch einmal eine Anleitung für die Einrichtung von HA Mosquitto broker Addon + HA MQTT Integration + Z2M unter HA.

Vorab: Ich habe das eben kurz nebenbei bei einer HA Test-VM gemacht und daher möge man mir verzeihen wenn ich jetzt nicht auf jede Kleinigkeit dabei eingehe und es nicht perfekt ist. :laughing: Los geht’s. :slightly_smiling_face:

Noch eine Anmerkung. Diese (Kurz)Anleitung beschreibt die erstmalige Einrichtung von Mosquitto broker Addon + HA MQTT Integration + Z2M. Falls man bei der Z2M Einrichtung bereits irgendwelche vergeblichen Versuche durchgeführt hat dann wäre die Vorgehensweise eine andere, die dann in der o.g. (Kurz)Anleitung zu dem Z2M Onboarding-Prozess beschrieben ist.

  1. Unter HA das Mosquitto broker Addon installieren. Den HA Add-on Store aufrufen und nach MQTT suchen.


    Installieren anklicken

    Nachdem die Installation erfolgt ist weicht die Installation von früheren Anleitungen und auch von der offiziellen Mosquitto broker Doku ab. Es müssen bei der Mosquitto broker Konfiguration keinerlei Einstellungen vorgenommen werden. D.h. es muss dort kein User eingerichtet werden. Auch muss - wieder im Gegensatz zu früher - unter HA auch kein extra User für den MQTT Broker angelegt werden. All das macht HA jetzt automatisch. Daher folgt als nächster Schritt den MQTT Broker direkt zu starten

    Wenn man das gemacht hat und das Mosquitto broker Addon läuft, kann man mal einen Blick in das Mosquitto broker Protokoll werfen. Das sollte dann so aussehen und man sieht das das Mosquitto broker Addon und somit auch der MQTT Server, läuft.

  2. Die MQTT Integration unter HA installieren. Dazu geht man bei HA zu Einstellungen —> Geräte & Integrationen und klickt dann unten rechts auf Integrationen hinzufügen.


    Dann einfach nach MQTT suchen und als Suchergebnis wird einem dann das angeboten. Davon installiert man dann MQTT

    Anschließend wird man gefragt ob man das offizielle Mosquitto MQTT Broker Add-on verwenden will, oder eben selber irgendeinen (externen) MQTT Broker einrichten möchte. Da wir ja das HA Mosquitto broker Addon verwendet wählt man also den ersten Punkt aus.

    Die Installation erfolgt dann kompl. automatisch und man braucht nichts weiter eingeben. Anschließend erscheint das.

    Damit ist die MQTT Installation unter HA bereits abgeschlossen. Um noch einmal zu überprüfen ruft man bei dem Mosquitto broker Addon noch einmal das Protokoll auf, das dann so in der Art aussehen sollte. Wie man unten sehen kann hat HA über den Supervisor und dessen IP 172.30.32.1, jetzt eine lokale Verbindung mit dem Mosquitto broker Addon hergestellt.

    Anm.: Die root/administrator Warnung kann man kompl. ignorieren. Die ist so normal.

Damit wäre die MQTT Broker Installation und Einrichtung unter HA abgeschlossen.

Wenn ich schon mal dabei bin dann zeige ich jetzt auch noch einmal wie man dann im Anschluss Z2M installiert und einrichtet. :slightly_smiling_face: Voraussetzung dafür ist das das Z2M Addon über den HA Add-on Store bereits als Repo hinzugefügt wurde, dort vorhanden ist


und bereits unter HA installiert wurde.
Ebenso wird vorausgesetzt das ein Zigbee Dongle bereits bei dem HA Host vorhanden ist und nicht bereits irgendwie von ZHA benutzt wird, oder in Beschlag genommen wurde. Sprich ZHA darf nicht aktiv sein und somit den Zugriff auf den Dongle irgendwie verhindern.

Bei der folgenden Z2M Installation nutze ich dafür wieder meinen Sonoff Dongle-P der an dem HA Host (oder genauer gesagt der HA VM) angeschlossen ist.

Wenn das Z2M Addon unter HA installiert und erstmalig gestartet wurde, sollten die Einträge in dem Z2M Protokoll so in der Art aussehen und Z2M “wartet” darauf über den Z2M Onboarding-Prozess erstmalig eingerichtet zu werden. Da dies bisher noch nicht passiert ist erscheint auch die Fehlermeldung zu der Supervisor API.


Als nächsten Schritt klickt man jetzt auf Benutzerfläche öffnen

und es startet dann automatisch der Z2M Onboarding-Prozess.

Dort wählt man dann seinen Dongle aus, der unter Select a device vorhanden sein sollte. Hier bei mir also der Sonoff Dongle-P.

Da ich bei der HA VM den Dongle über seine ttyUSB0 Schnittstelle und nicht über seine ID eingebunden habe, sieht die Konfiguration für ihn bei dem Z2M Onboarding-Prozess dann so aus.

Je nach verwendeten Dongle und wie dieser mit dem HA Host verbunden ist, können dort natürlich ganz unterschiedliche Einträge notwendig sein, auf die ich hier aber nicht weiter eingehe. Wenn der Dongle von Z2M offiziell unterstützt wird findet man die für ihn notwendigen Einstellungen bei den Z2M Infos zu den Adapter-Einstellungen:

Bei dem Z2M Onboarding-Prozess müssen auch keinerlei Einträge für den MQTT Broker vorgenommen werden, sofern man das Mosquitto broker Addon benutzt und es so eingerichtet hat wie ich es hier jetzt beschrieben habe. D.h. dort lässt man alles so stehen wie es automatisch eingetragen wurde.


Der Z2M Onboarding-Prozess kann dann über den Submit Button abgeschlossen und beendet werden.

Wenn man bei der Einrichtung keinen Fehler gemacht hat kommt als Nächstes das.

Dort klick man oben auf den Pfeil und dann sollte sich die Z2M Benutzeroberfläche öffnen, die dann so aussieht.

Dann kann man über den Button Beitritt erlauben anfangen seine Zigbee Geräte unter Z2M anzulernen. Was hier in dem Beispiel gerade für einen Tuya Tür-/Fenstersensor erfolgt ist.

Wenn man ein Gerät unter Z2M angelernt hat kann man bei der HA MQTT Integration auch prüfen ob dieses dort auch vorhanden ist - wie hier jetzt der Tuya Tür-/Fenstersensor

Auch kann man in dem Protokoll des Mosquitto broker Addon überprüfen ob das Gerät Daten an den MQTT Broker sendet. Das sollte dann so in der Art aussehen.

Die Z2M configuration.yaml Datei die der Z2M Onboarding-Prozess dann automatisch erstellt sieht in dem Beispiel hier dann wie folgt aus:

version: 4
mqtt:
  base_topic: zigbee2mqtt
  server: mqtt://core-mosquitto:1883
  user: addons
  password: pequ2kee1maeVooxoocheiGhez0naishohHaezeexaekaeceiDaikut3too1eipi
serial:
  port: /dev/ttyUSB0
  adapter: zstack
  baudrate: 115200
  rtscts: false
advanced:
  log_level: info
  channel: 11
  network_key:
    - 79
    - 232
    - 222
    - 86
    - 121
    - 120
    - 115
    - 209
    - 206
    - 129
    - 5
    - 145
    - 243
    - 101
    - 244
    - 4
  pan_id: 12782
  ext_pan_id:
    - 154
    - 165
    - 134
    - 187
    - 136
    - 243
    - 212
    - 37
frontend:
  enabled: true
  port: 8099
homeassistant:
  enabled: true
devices:
  '0xa4c138bd7fa5bbbd':
    friendly_name: '0xa4c138bd7fa5bbbd'

Somit wurde jetzt das HA Mosquitto broker Addon, die HA MQTT Integration und Z2M unter HA installiert. Sollte es dabei zu evtl. Problemen oder Fehlern kommen dann am besten hier im Forum erst einmal nach dem Problem/Fehler suchen, denn häufig findet man dann auch Beiträge oder Postings von anderen Usern, die bereits das gleiche Problem und/oder den gleichen Fehler hatten.

VG Jim

3 „Gefällt mir“
Sonoff Zigbee Bridge Pro als zweiten Router in HA integrieren
SMLIGHT SLZB-07 in Z2M integrieren
Zigbee2mqtt und Neuinstallation von HA
Zigbee2MQTTSerial
Mosquitto Broker und Zigbee2MQTT richtig konfigurieren
FYI: Anleitung für Z2M Installation mit Z2M Onboarding-Prozess (Update: Bitte auch mein Posting vom 16.04.2026 lesen da es Änderungen bei Z2M gab)
Kompletter Reset eines SMlight SLZB06-R (ZHA/zigbee2MQTT)
Sonoff zigbee 3.0 nicht in zigbee2mqtt
Kann zigbee2MQTT nicht installieren
Zigbee2MQTT Konfiguration
Problem mit Einrichtung Zigbee2MQTT: error: z2m: Error while starting zigbee-herdsman
Zigbee2MQTT V2.9.2-1 Erstinstallation - keine Anleitung passt mehr
Sonoff Dongle M, MQTT und Home Assistant
Problem mit Einrichtung Zigbee2MQTT: error: z2m: Error while starting zigbee-herdsman
FYI: Anleitung für Z2M Installation mit Z2M Onboarding-Prozess (Update: Bitte auch mein Posting vom 16.04.2026 lesen da es Änderungen bei Z2M gab)
FYI: Anleitung für Z2M Installation mit Z2M Onboarding-Prozess (Update: Bitte auch mein Posting vom 16.04.2026 lesen da es Änderungen bei Z2M gab)
Integration home assistant connect ZBT-1 hinzufügen scheitert
FYI: Anleitung für Z2M Installation mit Z2M Onboarding-Prozess (Update: Bitte auch mein Posting vom 16.04.2026 lesen da es Änderungen bei Z2M gab)
Z2M mit SLZB-06 MU über USB "Error while starting zigbee-herdsman" Anfängerprobleme
Mosquitto MQTT startet nicht
Kann zigbee2MQTT nicht installieren
Umstieg ZHA -> Z2M mit SLZB-06Mg24. Hänge schon bei Install "MQQT" fest
Neuinstallation Zigbee2MQTT läuft nicht
Zigbee2mqtt startet nicht mehr nach supervisor-update
Konfigurations Probleme mit Zigbee2MQTT
Problem mit Einrichtung Zigbee2MQTT: error: z2m: Error while starting zigbee-herdsman
Zigbee2Mqqt Startet nicht
Zigbee2MQTT startet nicht (mehr)
Zigbee lernt nichts an, wie kann ich das angehen
Zusatzlich zu ZHA + Zigbee2mttq zusammen als 2. Netz auf Homeassistant einrichten
SmLight SLZB-MR3 Beschreibung, Test und Installation in HA

Bevor hier User ggf. ins trudeln kommen: Raider heißt jetzt Twix und HA Addons jetzt halt “Apps”. :laughing: Zu dem Zeitpunkt der Erstellung der Anleitung waren der Mosquitto broker und Z2M eben noch Addons unter HA und dann sind die “Macher von HA” halt auf die Idee gekommen das HA Addons in Zukunft jetzt HA Apps heißen (müssen). :rofl:

VG Jim

Da hier in den letzten Tagen ein paar Beiträge/Postings aufgetaucht sind bei dem User im Nachgang Probleme mit dem

serial:
  port: /dev/ttyUSB0

Eintrag hatten den Z2M standardmäßig per Z2M Onboarding-Prozess vornimmt und ich darauf hier nicht noch einmal eingegangen bin. Die Info dazu findet man bei meiner anderen (Kurz)Anleitung zu der Einrichtung von Z2M, sprich da

Weiter unten ab: “Kommen wir noch zu ein paar “Nacharbeiten”, die zwar nicht unbedingt notwendig sind, aber die man durchaus machen könnte/sollte.”

Dort ist beschrieben wie man daraus

serial:
  port: /dev/ttyUSB0

dann z.B. das macht. :slightly_smiling_face:

serial:
  port: /dev/serial/by-id/usb-Silicon_Labs_CP2102N_USB_to_UART_Bridge_Controller_ceb3673b3793eb118f9b194f3d98b6d1-if00-port0

VG Jim

1 „Gefällt mir“

FYI: Der Abschluss des Z2M Onboarding-Prozesses sieht jetzt anders aus. Siehe dazu:

VG Jim