Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #648

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,30 @@ Edge version will not maintain a CHANGELOG and doesn't have a version.

If you find any issues with the add-on, please check the [issue tracker](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt/issues) for similar issues before creating one. If your issue is regarding specific devices or, more generally, an issue that arises after Zigbee2MQTT has successfully started, it should likely be reported in the [Zigbee2MQTT issue tracker](https://github.com/Koenkk/zigbee2mqtt/issues).

### Troubleshooting

`zigbee2mqtt` keeps some configuration in between re-installations of the add-on. It can lead to an error that doesn't prevent the add-on to start but disables a possibility to commision devices.
Example error log is below and is usually found by the end of the add-on initiation log:

```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!
```

To fix it, ensure a clean installation of the `zigbee2mqtt` add-on by using the official `ssh` plugin from HomeAssistant.
Remove remaining configuration files by launching a shell via browser or a direct ssh session and running:

```bash
[core-ssh ~] rm -rf /config/zigbee2mqtt
```

Re-install and re-configure the add-on. The error should be gone and in the absense of other issue, device comissioning should now be possible.

Feel free to create a PR for fixes and enhancements.

### Testing changes locally
Expand Down
Loading