Getting the Zigbee2MQTT Onboarding

Configuration Zigbee
1

trying to install zigbee2mqtt

had ZHA first removed that and did the complete installation
but getting to the onboard

image
image1519×828 58.3 KB

i think it means it can’t find the device

image
image1040×707 20.1 KB

what to do

image
image1351×677 30.2 KB

2

For Onboarding

  1. Place the Z2M in the sidebar to assist with onboarding

image
image868×760 36.8 KB

  1. Leave these fields clear in the Z2M config

image
image1620×440 8.49 KB

  1. Start Z2M and then click the SideBar link, you should see the onboarding screen.
  2. Fill in your config data there.
3

i get the onboarding screen,… but then what… it should show that you can add devices

4

Not if you already filled out the config fields, at least from my experience.

It is specified here

The configuration tab overrides onboarding

image
image2102×786 139 KB

5

i don’t understand what that means

6

It means if you add data on the Z2M config tab under mqtt and serial, it overrides the onboarding fields. That makes the Found Devices selection area unavailable in the onboarding interface

your code here

image
image1028×150 15.8 KB

disables this

image
image1064×120 6.83 KB

From my perspective, the Onboarding feature was designed to help with the install. When running Zigbee2MQTT via the Home Assistant, the addon ports are pre-determined.

The HA addon requires the frontend to run on port 8099 and needs the onboarding when it’s without a complete config file. This is adding confusion during installation based on the available documentation.

7

but then why am i getting this instead of the page to add devices

(thanks for taking your time to help me)

8

getting what? I don’t understand what you mean by this.

9

Where do you expect to see a page to add devices ?

afbeelding
afbeelding1451×204 11.3 KB

10

yes i expected to see this… but i get the onboarding… i expect that when i hit the tab zigbee2mttq

11

If you did not go through onboarding, that page will not show.

A shortcut is to edit /config/zigbee2mqtt/configuration.yaml, end delete the line
onboarding=true
but make sure zigbee2mqtt is stopped before you do that.

1 Like
12

onboarding is more trouble than it’s worth :man_facepalming:

13

i don;t have that in the file…
but maybe i can add it some where with the parameter false?
but where

version: 4
mqtt:
  base_topic: zigbee2mqtt
  server: mqtt://core-mosquitto:1883
  user: HA_MQTT
  password: xxxxx
serial:
  baudrate: 115200
  rtscts: false
  adapter: zstack
  port: >-
    /dev/serial/by-id/usb-ITead_Sonoff_Zigbee_3.0_USB_Dongle_Plus_08841791df9ced118c1477faa7669f5d-if00-port0
advanced:
  log_level: debug
  channel: 11
  network_key:
    - 114
    - 241
    - 76
    - 90
    - 35
    - 88
    - 185
    - 178
    - 107
    - 117
    - 0
    - 92
    - 28
    - 74
    - 151
    - 65
  pan_id: 43634
  ext_pan_id:
    - 91
    - 227
    - 142
    - 151
    - 11
    - 95
    - 27
    - 161
frontend:
  enabled: true
  port: 8099
homeassistant:
  enabled: true
14

What does your Mosquitto broker logs look like ?

15

thank you that was it it was turned off

1 Like
16

Happy it’s working!!

17

Good it is working. Just deleted the add-on, it was there when started again

version: 4
mqtt:
  base_topic: zigbee2mqtt
  server: mqtt://localhost:1883
serial: {}
advanced:
  log_level: info
  channel: 11
  network_key: GENERATE
  pan_id: GENERATE
  ext_pan_id: GENERATE
frontend:
  enabled: true
  port: 8099
homeassistant:
  enabled: true
onboarding: true

But you found the problem

18

I’ll try the same, but it’s (onboarding: true) not in my config.

One caveat…
I went back to 2025.5.3 until I figure out why I am having issues with my pond valve.

19

renamed the existing /config/zigbee2mqtt to /config/zigbee2mqtt_, then reinstalled, or it kept the existing configuration.

(I only run the add-on to test things, my production zigbee2mqtt is running bare-metal on another VM)

20

I have a test VM and will experiment with a reinstall there.

On my future endeavors list…