Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.35 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.35 KB
Raw

alt text

Home Assistant Add-on: Zigbee2mqtt

Run Zigbee2mqtt as a Home Assistant Add-on

Installation

Add the repository URL under Supervisor → Add-on store → ⋮ → Manage add-on repositories:

https://github.com/zigbee2mqtt/hassio-zigbee2mqtt

The repository includes two add-ons:

  • zigbee2mqtt is a stable release that tracks the released versions of zigbee2mqtt.
  • zigbee2mqtt-edge tracks the dev branch of zigbee2mqtt, so you can install the edge version if there are features or fixes in the dev branch that are not yet released.

After adding the repository, you may need to refresh your browser cache (ctrl + F5) before the add-on shows up in the store.

If the add-on doesn't start after installation, please go the the configuration tab at the top of the add-on page: Configuration → Add-ons → Zigbee2MQTT

The contents of the log tab, at that same location, can provide insight into what settings need to be edited.

For more information see the documentation.

Changelog

The format is based on Keep a Changelog.

All notable changes to this project will be documented in the CHANGELOG.md file.

Version for releases is based on zigbee2mqtt format: X.Y.Z.

Any changes on the addon that do not require a new version of zigbee2mqtt will use the format: X.Y.Z-A where X.Y.Z is fixed on the zigbee2mqtt release version and A is related to the addon.

Edge version will not maintain a CHANGELOG and doesn't have a version.

Issues

If you find any issues with the add-on, please check the issue tracker 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.

Feel free to create a PR for fixes and enhancements.

Credits