Launch of the zigpy-ota repo

[TheJulianJES]

Welcome to zigpy-ota

Welcome to the zigpy-ota repository — the central hub for Zigbee OTA firmware images used by zigpy, Home Assistant's ZHA integration, and other zigpy-based applications.

Before You Start

Please read the README to understand how this repository works.

Quick Rundown

You can browse all available firmware images in the index via the links in the "Browse available firmware" section of the README.

For ZHA users: No configuration is required to use zigpy-ota with Home Assistant 2026.1.0 or later. Firmware updates are available automatically through the ZHA integration.

For Zigbee2MQTT users: An experimental index is also generated for use with Zigbee2MQTT. You can configure it in your Z2M configuration.yaml:

ota:
  zigbee_ota_override_index_location: https://raw.githubusercontent.com/zigpy/zigpy-ota/release/files/stable/z2m_v1_ota.json

Current Status

This project is in its early stages:

• Manufacturers are welcome to submit their firmware images. If you are a device manufacturer, feel free to submit your OTA firmware by creating an issue.
• Otherwise, please only submit OTA firmware images if you have been asked to do so by a maintainer, or if you have reached out to a maintainer and received permission first (feel free to ask in this thread).
• We plan to open contributions to the full community soon.

Note: Please do not submit Philips Hue firmware images at this time.

Goal: Stable firmware

The goal of zigpy-ota is to provide fully stable, verified firmware to end users. Quality and reliability are critical since firmware updates pushed through this repository reach Home Assistant users worldwide.

A beta channel is also available for firmware that may be less stable or is still being validated. This allows users who opt in to test newer firmware before it reaches the stable channel. For more information, expand the "Using pre-release channels" section in the README.

Warning: Firmware on the beta or dev channels may be unstable and can potentially brick your devices. Use these channels at your own risk.

How to Use GitHub Issues vs. Discussions

• GitHub Issues — Reserved for:
  • OTA firmware submissions (via the issue forms)
  • Bug reports related to tooling or firmware
• GitHub Discussions — Use for:
  • Questions about the project
  • Feedback and suggestions
  • General conversation

Questions?

If you have any questions about the project, feel free to ask them right here in this thread.

[Hedda]

It is awesome work that you have done with this!

I assume that the existing/old OTA providers that was previous supported in zigpy will still be used by zha for now, but understand that in the future zigpy/zha devs would prefer if all those manufactuers also move to using this new zigpy-ota repo and the new zigpy-ota provider, or?

Also assume that sooner or later zigpy/zha devs will probably want to deprecate all of the older OTA providers available directly in the zigpy library today, meaning that then Zigbee OTA images will need to be provided via the new zigpy-ota repo or else they will no longer be be available via zigpy/zha, or?

Previous OTA providers for manufacturers that zigpy provide today that will need to be moved or risk being removing from zigpy/zha:

• IKEA
• Inovelli
• Ledvance/OSRAM
• Sonoff/iTead
• Third Reality (a.k.a. ThirdReality, a.k.a. 3reality)

Is there a plan/roadmap (not under an non-disclosure agreement or trust-me-bro secret) to export and import OTA images from some or all OTA providers for manufacturers that do not currently have a partnership with the Open Home Foundation? I.e. IKEA, Inovelli, Ledvance/OSRAM, and Sonoff/iTead?

• https://works-with.home-assistant.io/

By the way, zigpy readme has not yet been updated:

• https://github.com/zigpy/zigpy/blob/dev/README.md#zigbee-device-ota-updates

Niether has the ZHA integration end-user documentation:

• https://www.home-assistant.io/integrations/zha#ota-updates-of-zigbee-device-firmware

Anyway, great job with all this so far!

[TheJulianJES]

Existing OTA providers that pull updates directly from manufacturers without any verification (and with no release notes) are still available. We do plan to eventually deprecate them because of all advantages that zigpy-ota has.

Is there a plan/roadmap [...] to export and import OTA images from some or all OTA providers for manufacturers

Some manufacturers, like Sonoff, have started providing new updates to zigpy-ota now. Ideally, all existing updates are ported over with release notes, though it may be difficult to get changelogs for older updates.

And thanks for the note on documentation. We'll update it soon but it may be difficult to explain for which manufacturers we provide updates now. 😅

[Hedda]

Goal: Stable firmware

The goal of zigpy-ota is to provide fully stable, verified firmware to end users. Quality and reliability are critical since firmware updates pushed through this repository reach Home Assistant users worldwide.

A beta channel is also available for firmware that may be less stable or is still being validated. This allows users who opt in to test newer firmware before it reaches the stable channel. For more information, expand the "Using pre-release channels" section in the README.

Warning: Firmware on the beta or dev channels may be unstable and can potentially brick your devices. Use these channels at your own risk.

In addition to allowing ZHA users to choose geting OTA-updates from stable, beta or dev channel, have you considered in the future enabling some kind of filter (also available in the UI) to allow ZHA users to select if they only want to get firmware images submitted by verified manufacturers or if they want to select getting community-submitted contributions as well?

Directly related to what is Originally posted by @TheJulianJES in #1 here:

For now, please only submit OTA firmware images if you have been explicitly asked to do so by a maintainer. We are still setting up the submission process and will open it up for community contributions soon.

That is, when you start allowing community contributions then you have settings for it in zha so that end-user explicitly needs to enable getting OTA community contributions by default, however that it should still be relativly easy to enable it via ZHA's control panel UI in Home Assistant, but with a pop-up warning with a disclaimer that the user understands the risk with community contributions OTA updates.

The point with this would be make it simpler to get a larger collection of Zigbee OTA for a wider range of devices similar to koenkk's zigbee-ota collection (which is used by default in Zigbee2MQTT) while still not getting all those by default in ZHA if user do not explicitly enable it:

• https://github.com/koenkk/zigbee-ota

  • https://www.zigbee2mqtt.io/guide/usage/ota_updates.html

PS: Off-topic but FYI, the section about Zigbee OTA updates in ZHA integration end-user documentation has not yet been updated:

• https://www.home-assistant.io/integrations/zha#ota-updates-of-zigbee-device-firmware

[TheJulianJES]

Somewhat, yes. We do plan to expose a UI option in the ZHA options to easily switch between stable and beta channels.

The beta channel could include more of the community contributions. Already, we show a link in the release notes for every update in Home Assistant, where you can quickly open the corresponding zigpy-ota PR. There, users can report issues with the update (or post success stories). Depending on the feedback, updates could be removed/disabled entirely, or pushed to the stable channel.

Initial PR (though this will need some changes + other PRs as well):

• Add config option to use zigpy-ota beta channel zha#617

[Hedda]

FYI, it looks as if Bosch has now published official Zigbee OTAU files for Bosch Smart Home devices on GitHub in this repository:

• https://github.com/BoschSmartHome/bosch-smart-home-files

Ping @samuelfleischle & @sebastianharder