zigbee2mqtt / hassio-zigbee2mqtt

Official Zigbee2MQTT Home Assistant add-on
https://www.zigbee2mqtt.io
Apache License 2.0
1.18k stars 432 forks source link

Update README.md #648

Open artemkovalyov opened 1 month ago

artemkovalyov commented 1 month ago

Add a solution to a common problem that affects users who needed to re-install the plugin in HA for whatever reason. The solution is confirmed and validated by many users in this thread: https://github.com/Koenkk/zigbee2mqtt/issues/24317 I used it myself to troubleshoot the ad-on start up after the re-installation.

Koenkk commented 1 month ago

Could you provide the debug log of this issue? It shouldn't happen in the first place.

artemkovalyov commented 1 month ago

@Koenkk, it looks exactly like the one in the issue attached or do you ask for a different log?

[2024-10-04 14:54:07] error:    z2m: Failed to call 'HomeAssistant' 'start' (TypeError: Cannot read properties of undefined (reading 'deviceIeeeAddress')
    at HomeAssistant.getBridgeEntity (/app/lib/extension/homeassistant.ts:2016:78)
    at HomeAssistant.start (/app/lib/extension/homeassistant.ts:476:28)
    at Controller.callExtensions (/app/lib/controller.ts:399:17)
    at Controller.start (/app/lib/controller.ts:218:9)
    at start (/app/index.js:154:5))
[2024-10-04 14:54:07] info:     z2m: Zigbee2MQTT started!

In my case I was re-installing the add-on because of testing between ZHA and Zigbee2mqtt. After I solved the issues with the dongle firmware, I started to see the error above. Removing the remainders of configs and re-installing the add-on instantly solved it. Same as for a few people in this issue: https://github.com/Koenkk/zigbee2mqtt/issues/24317

If I had more time, I'd debug for a PR to fix it. I'm relatively new to the HA ad-ons. Although outdated and not cleaned up configuration with dangling IDs or bogus Entities has already affected me in HA.

artemkovalyov commented 1 month ago

If you don't want it in the plugin's manual I can create smth like a troubleshooting or known-issue doc. I mean, if you dig for some time you might find the issue, but with so much noise being around it wasted me quite a bit of time. Before this is properly fixed, such docs would make my day.

Thanks for investing into this awesome project by the way!

Koenkk commented 4 weeks ago

Before adding this, let's first analyse a bit what the problem is. I will need the debug logging + database.db file of when this happens.

See this on how to enable debug logging.