Zha doc enhancements (#37492)

* Break out ZHA OTA vendors to a list

* remove redundant header in ZHA hardware section

* Remove trailing spaces from ZHA docs

* tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
kylehakala 2025-02-16 22:42:01 -06:00 committed by GitHub
parent 972828ceb3
commit c2d15aa3dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -226,7 +226,15 @@ Additional devices in the [Known working Zigbee radio modules](#known-working-zi
The ZHA integration has the ability to perform OTA (over-the-air) firmware updates of Zigbee devices. This feature is enabled by default. As it uses standard [Update](/integrations/update/) entities in Home Assistant, users will get a UI notification if and when an OTA firmware update is available for a specific device, with an option to initiate the update or ignore that specific update for the device. The ZHA integration has the ability to perform OTA (over-the-air) firmware updates of Zigbee devices. This feature is enabled by default. As it uses standard [Update](/integrations/update/) entities in Home Assistant, users will get a UI notification if and when an OTA firmware update is available for a specific device, with an option to initiate the update or ignore that specific update for the device.
To see OTA updates for a device, it's required that it both supports OTA updates and that firmware images for the device are publicly provided by the manufacturer. For this reason, ZHA currently only includes OTA providers for a few manufacturers that provide these updates publicly. This includes IKEA, Inovelli, Ledvacnce/OSRAM, SALUS/Computime, Sonoff/iTead, and Third Reality. To see OTA updates for a device, it must support OTA updates and firmware images for the device must be publicly provided by the manufacturer. ZHA currently only includes OTA providers for a few manufacturers that provide these updates publicly.
**Included manufacturers:**
- IKEA
- Inovelli
- Ledvacnce/OSRAM
- SALUS/Computime
- Sonoff/iTead
- Third Reality
{% warning %} {% warning %}
Before updating a device, you should search for any disadvantages or if you even need to install an available update. Some firmware updates can break features you might use (e.g. group binding for IKEA devices). Some updates might also require changes to ZHA. In rare cases, you can even brick devices by installing a firmware update. Before updating a device, you should search for any disadvantages or if you even need to install an available update. Some firmware updates can break features you might use (e.g. group binding for IKEA devices). Some updates might also require changes to ZHA. In rare cases, you can even brick devices by installing a firmware update.
@ -515,6 +523,7 @@ Tip to new Zigbee users: Checkout [blakadder's unofficial Zigbee Device Compatib
### How to add support for new and unsupported devices ### How to add support for new and unsupported devices
If your Zigbee device pairs/joins successfully with the ZHA {% term integration %} but does not show all of the expected entities: If your Zigbee device pairs/joins successfully with the ZHA {% term integration %} but does not show all of the expected entities:
1. Try to re-pair/re-join the device several times. 1. Try to re-pair/re-join the device several times.
2. Checkout the troubleshooting section. 2. Checkout the troubleshooting section.
3. Still not working? You may need a custom device handler. This handler will have exception handling code to work around device-specific issues. 3. Still not working? You may need a custom device handler. This handler will have exception handling code to work around device-specific issues.
@ -524,6 +533,7 @@ For devices that do not follow the standard defined in the CSA's ZCL (Zigbee Clu
People familiar with other Zigbee gateway solutions for home automation may know similar concepts of using custom Zigbee device handlers/converters for non-standard devices. For example, [Zigbee2MQTT (and IoBroker) uses zigbee-herdsman converters](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html) and [SmartThings Classics (Legacy) platform has Hub Connected Device Handlers](https://developer.smartthings.com/docs/devices/hub-connected/legacy). People familiar with other Zigbee gateway solutions for home automation may know similar concepts of using custom Zigbee device handlers/converters for non-standard devices. For example, [Zigbee2MQTT (and IoBroker) uses zigbee-herdsman converters](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html) and [SmartThings Classics (Legacy) platform has Hub Connected Device Handlers](https://developer.smartthings.com/docs/devices/hub-connected/legacy).
If you do not want to develop such a "quirk" Python script yourself, you can submit a "device support request" as a new issue to the [ZHA Device Handlers project repository on GitHub](https://github.com/zigpy/zha-device-handlers/issues): If you do not want to develop such a "quirk" Python script yourself, you can submit a "device support request" as a new issue to the [ZHA Device Handlers project repository on GitHub](https://github.com/zigpy/zha-device-handlers/issues):
1. Sign in to GitHub. 1. Sign in to GitHub.
2. Select **New issue** and follow the instructions. 2. Select **New issue** and follow the instructions.
- New device support requests require the device signature + diagnostic information. - New device support requests require the device signature + diagnostic information.