FYI: Anleitung für Z2M Installation mit Z2M Onboarding-Prozess

Moin zusammen.

Da hier in letzter Zeit immer wieder Beiträge auftauchen bei denen User Schwierigkeiten bei der Ersteinrichtung von Z2M mit dem Z2M Onboarding-Prozess haben und dann z.T. auch “komische” Ratschläge von anderen Usern kommen, wie z.B. das man bei einem Sonoff Dongle-P doch mal ember als adapter: probieren sollte, :rofl: oder auch das man die Z2M configuration.yaml manuell erstellen müsste/sollte, :slightly_smiling_face: habe ich den Z2M Installationsprozess per Z2M Onboarding eben mal durchgespielt. Dafür hier jetzt mal eine (Kurz)Anleitung. :wink:

Vorab: Ich habe das bei mir mit einem Proxmox Host gemacht, unter dem dann eine Test HA VM läuft. Aber das funktioniert in der Form natürlich auch bei einer HA bare metal Installation.

Zum Einsatz kamen:
Proxmox + HA VM
Sonoff Dongle-P
HA Core 2025.10
Mosquitto broker 6.5.0
Z2M 2.6.3-1

Vorausgesetzt wird das das Mosquitto broker Addon gem. Doku unter HA bereits installiert und gestartet wurde und das das Z2M Addon Repo bei den HA Addons bereits vorhanden ist. Auch sollte man für die weiter unten erwähnten “Nacharbeiten” das File Editor Addon bereits unter HA installiert haben.

Ebenfalls vorausgesetzt ist das ZHA nicht auch noch installiert und aktiviert und für den gleichen Coordinator eingerichtet ist. Das funktioniert nicht. :slightly_smiling_face: Ein Zigbee Coordinator kann bekanntlich immer nur von Z2M oder ZHA benutzt werden. Bevor man Z2M installiert muss also ZHA deinstalliert werden und wenn ZHA sich nach einem Reboot von HA dann ggf. wieder “meldet” und den Coordinator wieder für ZHA einrichten will, muss man ZHA ignorieren und darf es nicht wieder einrichten.

Los geht’s. :slightly_smiling_face:

Falls man wie ich den USB-Dongle (hier ein Sonoff Dongle-P) an einem Proxmox Host angeschlossen hat hier noch die Schritte die man dort machen kann bzw. muss.

  1. USB-Dongle per USB-Kabel (Länge sollte mind. 0,5 Meter sein) an den Proxmox Host anschließen.
  2. Per lsusb nachschauen ob der Dongle von dem Proxmox Host auch erkannt wird.
  3. Den USB-Dongle bei der HA VM über Hardware —> Add —> USB-Device hinzufügen.

    Anm.: Ich habe dafür schon immer Use USB Port genutzt, aber eine Einbindung per Use USB Vendor/Device ID funktioniert ebenfalls und was dann von beiden der ggf. bessere oder sinnvollere Weg ist soll hier nicht Thema sein.
  4. Damit ist das Thema anschließen des USB-Dongle an den Proxmox Host und durchreichen an die HA VM erledigt.

Kommen wir nun zu HA und der Einrichtung von Z2M.

  1. Bei HA über Einstellungen —> System —> Hardware —> Gesamte Hardware nachschauen ob dort der USB-Dongle auftaucht. Das sollte dann z.B. so aussehen:
  2. Den dort vorhandenen Eintrag hinter ID kopieren. Dieser wird später noch einmal gebraucht.
  3. Bei den HA Addons das Z2M Addon aufrufen und es per Installieren-Button installieren.
  4. Nachdem es installiert wurde sieht die Oberfläche dann so aus und man aktiviert dort die drei Optionen.

    Anschließend klickt man auf den Starten-Button und es erscheint diese Oberfläche.

    auf der man dann auf den Benutzerfläche öffnen Button klickt.
  5. Jetzt öffnet sich die Onboarding-Seite von Z2M die dann so aussieht.

    Dort muss man per Select a device den USB-Dongle auswählen. Hier in dem Beispiel also den Sonoff Dongle-P, der unter /dev/ttyUSB0 vorhanden ist. Wenn der Dongle von Z2M richtig erkannt wurde wird auch gleich automatisch der passende Driver für ihn ausgewählt und eingetragen. Hier bei einem Sonoff Dongle-P also zstack. Anm.: Bei einem Sonoff Dongle-E sollte dort ember stehen. Außer dann bei dem Wifi-Kanal noch zu schauen ob man den dort vorausgewählten übernehmen oder ggf. ändern will, brauchen bei der Z2M Onboarding-Seite keine weiteren Einstellungen gemacht werden und man kann unten auf der Seite auf den Submit-Button klicken.
  6. Wenn man auf den Submit-Button geklickt hat und man ggf. auch keinen Fehler gemacht hat, sollte als nächstes automatisch folgende Seite erscheinen

    und die Z2M Einrichtung per Z2M Onboarding-Seite wurde erfolgreich abgeschlossen. Dann kommt der Punkt an dem hier wohl schon der ein oder andere User gescheitet ist, :laughing: nämlich: Was genau heißt “You can close this page”. Lösung: Einfach oben auf den Pfeil klicken :wink: und man bekommt direkt die Z2M Oberfläche zu Gesicht. Sollte man zumindest wenn man nichts falsch gemacht hat. :slightly_smiling_face:
  7. Die grundsätzlich Z2M Einrichtung per Z2M Onboarding-Seite ist abgeschlossen und Z2M sollte ab dem Zeitpunkt laufen und funktionieren.

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

Per HA File Editor Addon öffnet man die Z2M configuration.yaml unter dem Pfad: /homeassistant/zigbee2mqtt/configuration.yaml Die sieht dann z.B. so aus.

Wie man sehen kann steht in der aktuell unter serial: als port: noch port: /dev/ttyUSB0, was so zwar grundsätzlich auch funktioniert, aber besser ist es dort die ID des USB Dongle einzutragen. Jetzt kommt der Eintrag zum tragen den man sich vorher über Einstellungen —> System —> Hardware —> Gesamte Hardware kopiert hatte. In dem Beispiel hier lautet der ID-Pfad bei mir:

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

Diesen Pfad trägt man jetzt bei serial: ein und ersetzt dort alten …/ttyUSB0 Pfad. Das sieht dann so aus.


Anschließend die Änderung per Icon oben rechts speichern.

Zum Schluss sollte man HA einmal kompl. neu booten.

Nach dem Reboot von HA sollte Z2M laufen und funktionieren und man kann mal einen Blick in das HA Z2M Protokoll werfen, was dann so in der Art aussehen sollte.

[08:40:00] INFO: Socat not enabled
[08:40:01] INFO: Starting Zigbee2MQTT...
Starting Zigbee2MQTT without watchdog.
[2025-11-03 08:40:02] info: 	z2m: Logging to console, file (filename: log.log)
[2025-11-03 08:40:02] info: 	z2m: Starting Zigbee2MQTT version 2.6.3 (commit #unknown)
[2025-11-03 08:40:02] info: 	z2m: Starting zigbee-herdsman (6.3.2)
[2025-11-03 08:40:02] info: 	zh:zstack:znp: Opening SerialPort with {"path":"/dev/serial/by-id/usb-Silicon_Labs_CP2102N_USB_to_UART_Bridge_Controller_ceb3673b3793eb118f9b194f3d98b6d1-if00-port0","baudRate":115200,"rtscts":false,"autoOpen":false}
[2025-11-03 08:40:02] info: 	zh:zstack:znp: Serialport opened
[2025-11-03 08:40:02] info: 	z2m: zigbee-herdsman started (resumed)
[2025-11-03 08:40:02] info: 	z2m: Coordinator firmware version: '{"meta":{"maintrel":1,"majorrel":2,"minorrel":7,"product":1,"revision":20230507,"transportrev":2},"type":"ZStack3x0"}'
[2025-11-03 08:40:02] info: 	z2m: Currently 0 devices are joined.
[2025-11-03 08:40:02] info: 	z2m: Connecting to MQTT server at mqtt://core-mosquitto:1883
[2025-11-03 08:40:03] info: 	z2m: Connected to MQTT server
[2025-11-03 08:40:03] info: 	z2m:mqtt: MQTT publish: topic 'zigbee2mqtt/bridge/state', payload '{"state":"online"}'
[2025-11-03 08:40:03] info: 	z2m: Started frontend on port 8099
[2025-11-03 08:40:03] info: 	z2m: Zigbee2MQTT started!

Anm.: Sollte es ggf. doch ein Problem bei der Z2M Installation gegeben haben und man möchte noch einmal kompl. bei Null anfangen, reicht es nicht aus das Z2M Addon einfach nur zu deinstallieren. Dadurch verbleiben nämlich noch “Reste” in dem Z2M Ordner unter HA. Stattdessen muss man aus dem Z2M Ordner unter /homeassistant/zigbee2mqtt die darin noch vorhandenen Dateien per File Editor Addon löschen. D.h. die Datein die man hier sieht.


Anm.: Den log-Ordner muss man nicht unbedingt löschen.
Nach dem löschen der Dateien sollte man HA sicherheitshalber noch einmal kompl. booten.

So das soll es dann auch gewesen sein. Ich hoffe das User mit dieser Anleitung etwas anfangen können und das das Thema Z2M Onboarding-Prozess und der Ablauf dabei, dadurch auch geklärt, bzw. klarer wurde. :slightly_smiling_face:

Anm.: Ja es gibt auch noch ein paar Feinheiten die man ggf. anders machen könnte, aber mir ging es hier in erster Linie darum den Z2M Onboarding-Prozess zu zeigen und nicht darum was man ggf. alles noch irgendwie anders machen könnte.

VG Jim

3 „Gefällt mir“

Wird in meinem SLZB-06 nach wie vor empfohlen, ich habe mein Z2M auch nicht anders ans laufen bekommen, als durch händisches editieren. Ist aber noch vor “onboarding” gewesen.

Löst demnach “onboarding” das bekannte Problem?

Falls Du damit meinst das irgendwelche Dinge/Daten ggf. nicht in die Z2M configuration.yaml übernommen werden. Ja das Problem wird/ist damit gelöst. :slightly_smiling_face:

Durch den Z2M Onboarding-Prozess muss man weder bei der Z2M Addon Konfiguration
Z2M_Konfiguration

noch in der Z2M configuration.yaml, irgendwelche Dinge manuell machen oder eintragen. Das erledigt der Z2M Onboarding-Prozess kompl. selbstständig und automatisch.

Anm.: Ich kann mich natürlich nur auf meinen “Selbstversuch” mit einem Dongle-P und den o.g. Voraussetzungen beziehen und das soll nicht heißen das es nicht vielleicht doch noch irgendwelche Konstellationen gibt bei denen man ggf. etwas anders machen muss. Aber bei einem Sonoff Dongle-P (oder halt auch Sonoff Dongle-E) sollte das alles wie oben beschieben funktionieren. Ob das dann auch für einen LAN-Zigbee Dongle gilt habe ich nicht getestet und im Fall eines SLZB-06 (oder Ähnlichen) kann man ja auch noch ein paar zusätzliche Einträge (LED, Power) in der Z2M configuration.yaml vornehmen und diese im Nachgang ja wie bisher auch manuell editieren.

VG Jim

Nach Änderungen in der ZigBee2MQTT configuration.yaml ist kein Reboot notwendig. Ein Neustart von ZigBee2MQTT ist vollkommen ausreichend.

Auch sollte man beim editieren der configuration.yaml zuvor ZigBee2MQTT stoppen.

Auch kann man das onboarding überspringen. Und nach der Installation von ZigBee2MQTT die komplette Konfiguration direkt in der configuration.yaml durchführen, speichern und ZigBee2MQTTT starten. Vor allem wenn man ohnehin größere Anpassungen in der Konfiguration vornehmen möchte oder muss.

Viel wichtiger wäre aber den Usern zu vermitteln, das es eine sehr gute ZigBee2MQTT Dokumentation gibt, die es sich wirklich lohn zu studieren. :wink:

Gruß Osorkon

Ja könnte man, aber warum sollte man. :laughing:

Ich weiß zwar nicht welche “größeren Anpassungen” das sein sollen, für die man auf den einfachen Onboarding-Prozess (besser) ganz verzichten sollte - insbesondere weil man die Z2M configuration.yaml nach dem Onboarding-Prozess natürlich auch jederzeit noch verändern kann - aber ja man kann die Einrichtung von Z2M natürlich auch weiterhin so

und somit “zu Fuß” machen. Jeder wie er möchte. :slightly_smiling_face:

Stimmt ich hätte hier auch noch schreiben und somit den Usern vermitteln können, dass die User doch bitte die sehr gute Zigbee2MQTT Doku lesen sollen, in der ja alles beschrieben steht und eigentlich hätte ich mir diese (Kurz)Anleitung ja auch sparen können. :laughing: Daher noch einmal: Liebe User lest bitte die sehr gute Zigbee2MQTT Doku.

Ich bin dann hier raus :laughing: und ich hoffe das der ein oder andere Usern meine (Kurz)Anleitung für den Z2M Onboarding-Prozess - trotz sehr guter Zigbee2MQTT Doku - ggf. trotzdem gebrauchen kann. :slightly_smiling_face:

VG Jim

1 „Gefällt mir“

Hallo Jim_OS,

Dank Deiner (Kurz)Anleitung habe ich direkt beim ersten Versuch Z2M zum Laufen bekommen.

Vor einer Woche habe ich frustriert aufgegeben, aber mit Deiner Anleitung hat es direkt funktioniert.

Vielen Dank dafür.

Gruß Wilfried

Hallo Jim_OS,

Vielen Dank für diese super Anleitung. Nachdem ich jetzt fast den ganzen Nachmittag verzweifelt versucht habe, Z2M ans Laufen zu bringen, ging es mit deiner Anleitung ganz schnell.
Nochmal vielen, vielen Dank für deine Arbeit!

Gruß
vokamale

@moppedhausi und @vokamale
Fein das ich Euch ein wenig damit helfen konnte. :slightly_smiling_face: Wie gesagt ging es mir in erster Linie darum, wie es ja bereits in der Betreffzeile steht, den Ablauf bei dem Z2M Onboarding-Prozess zu beschreiben und nicht darum was man sonst noch irgendwie, oder irgendwie anders machen könnte. Eben weil hier in letzter Zeit immer mal wieder Beiträge aufgetaucht sind bei denen User irgendwelche Probleme mit dem Z2M Onboarding-Prozess hatten.

VG Jim

Hallo zusammen,

ich möchte bei mir auch endlich mal Zigbee2MQTT installieren und habe noch ein paar Fragen, da es wohl einige Änderungen gab und die Anleitungen teilweise veraltet sind.

Ich habe den SLZB-06p7.

Mosquitto broker Addon ist installiert - Konfiguration standard gelassen.

MQTT Addon ist installiert - Konfiguration standard gelassen.

Benutzer “mqttuser” erstellt –> wird das überhaupt noch benötigt?

Zigbee2MQTT installiert, YAML direkt bearbeitet und mit den Daten meiner SLZB gefüttert.

Nun bin ich beim Onboarding-Screen.

Das wurde ja anscheinend alles von der YAML gezogen und ist deshalb ausgegraut:

Wieso kann ich den MQTT User nicht ändern bzw. soll ich den überhaupt ändern?

Dann muss das wohl, so wie ich das verstehe in der configuration.yaml geschehen, richtig?

Ich hätte gedacht, dass ich hier meinen erstellten User angeben muss?

Soll ich an den restlichen Einstellungen was ändern?

Closest WIFI Channel, Network Channel, Network Key usw.

Nein

Nein - zumindest dann nicht wenn Du nicht irgendwelche individuellen Einstellungen vornehmen willst. Z.B. was den Zigbee Kanal betrifft. Zu dem Thema Zigbee und WLAN Kanäle und welche man dann wo am besten wählt, siehe die div. Beiträge und Postings hier im Forum.

VG Jim

1 „Gefällt mir“

Danke dir für die schnelle Antwort.

Wo sehe ich denn aber das aktuelle Passwort für den User “addon”?

Ich habe jetzt mal eine Hue-Leuchte hinzugefügt. Funktioniert alles.

Das einzige, das mich verwirrt ist, dass bei der Leuchte unter “Verfügbarkeit” mit “Deaktiviert” angegeben ist. Ist das normal? Ich habe zwar in die Doku geschaut und da ist es als “Verfügbarkeitsfunktion” angegeben aber scheint es ja bei mir nicht zutreffend zu sein.

Zu 1: Sehen kannst Du das nirgends, aber da Du ja für den MQTT Broker unter HA einen neuen User angelegt hast

Create a new user for MQTT via your Home Assistant's frontend Settings -> People -> Users , (i.e. not on Mosquitto's Configuration tab). Notes:

This name cannot be homeassistant or addons, those are reserved usernames.
If you do not see the option to create a new user, ensure that Advanced Mode is enabled in your Home Assistant profile.

solltest Du dessen PW ja eigentlich noch kennen. Der User ist der “addon-User”.

Zu 2: Da das hier bei dem Beitrag eher OT ist solltes Du dazu besser entweder a) bei einem bereits bestehenden (ähnlichen) Beitrag dazu ein Posting erstellen oder b) einen extra neuen Beitrag dazu erstellen. Irgendwelche Fragen zu HUE-Leuchten passen hier nun wirklich nicht zu dem Beitrag mit dem Z2M Onboarding-Prozess (Edit: Auch wenn sie über Z2M eingebunden wurden). :slightly_smiling_face:

VG Jim

Ja, das Passwort, von dem von mir erstellten mqttuser kenne ich natürlich.

Mir ging es darum, dass ich ja beim Onboarding keine Möglichkeit habe, User und Passwort zu ändern.

Ich habe also noch nicht verstanden, für was ich den User erstellen sollte, wenn ich diesen nirgends eintragen kann.

Weil es ohne User nicht funktioniert. :laughing:

Früher musste man den User und dessen PW auch noch “zu Fuß” eintragen. Inzwischen (bereits seit ein paar Jahren) holt sich Z2M die Daten automatisch, eben dadurch das da für User auf addons “verwiesen” wird. Das ist aber eben auch schon lange so und das war auch schon so als es den Z2M Onboarding-Prozess noch nicht gab.

VG Jim

Da es gerade so einen Fall gab und ich davon ausgegangen bin das so etwas eh bekannt ist, :slightly_smiling_face: dazu noch ein Nachtrag.

Ebenfalls vorausgesetzt ist das ZHA nicht auch noch installiert und aktiviert und für den gleichen Coordinator eingerichtet ist. Das funktioniert nicht. :slightly_smiling_face: Ein Zigbee Coordinator kann bekanntlich immer nur von Z2M oder ZHA benutzt werden. Bevor man Z2M installiert muss also ZHA deinstalliert werden und wenn ZHA sich nach einem Reboot von HA dann ggf. wieder “meldet” und den Coordinator wieder für ZHA einrichten will, muss man ZHA ignorieren und darf es nicht wieder einrichten.

VG Jim

Ich stimme für ein Sticky Topic!