Update ZHA section about Zigbee OTA #28895

Hedda · 2023-09-13T12:00:36Z

Proposed change

Update/improve section about Zigbee OTA/OTAU for the ZHA integration, including zigpy's new "Generic OTA providers" support.

References:

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logo's and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes # Conflicting information on THIRDREALITY device compatibility for OTA updates #28198

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Update section about Zigbee OTA for ZHA

home-assistant · 2023-09-13T12:16:29Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

Hedda · 2023-10-12T11:06:23Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

This is currently targeting current branch on purpose as it is only the ZHA documentation that is updated and none of the code.

Why is this tagged with "needs-rebase"? Is it because wrote PR fixes or closes issue: fixes # #28198 under additional information?

netlify · 2024-03-11T13:17:58Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`e077a36`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6634f1b8cf23750008639da6
😎 Deploy Preview	https://deploy-preview-28895--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

source/_integrations/zha.markdown

puddly

Thanks! I think we want to shrink the size of this PR and remove content from the existing OTA docs, as a lot is no longer relevant.

Advanced features that are meant for developers should also be removed from the documentation. We want to keep integration documentation as short as possible. Otherwise, people are overwhelmed.

source/_integrations/zha.markdown

home-assistant · 2024-03-12T19:38:41Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

source/_integrations/zha.markdown

Hedda · 2024-03-25T09:00:11Z

I tried to rewrite/update to meet the current feature-set but perhaps someone else would rather prefer to start over from scratch?

This was originally submitted in beginning of September 2023 and much/most has changed since, so maybe better to just close it?

erkr

This is a big improvement!

erkr

@Hedda Just some minor remarks on the new OTA from a end user perspective.

One other remark. Reading various ZHA discussions revealed other options that are NOT mentioned in the new documentation. Are those options valid. If so how to use them:

  ota:
    # It's enabled by default
    enabled: true

    # Periodically send out a network-wide (including end devices!) image notification
    broadcast_enabled: true
    broadcast_initial_delay: 14400
    broadcast_interval: 14400

    # Points to Z2M OTA `index.json` if stored locally
    z2m_local_index: /path/to/z2m-ota/index.json

    # Points to Z2M OTA `index.json` URL
    z2m_remote_index: "https://raw.githubusercontent.com/Koenkk/zigbee-OTA/master/index.json"

source/_integrations/zha.markdown

puddly · 2024-05-03T12:56:59Z

Are those options valid. If so how to use them

OTA is meant to require no configuration and the defaults are carefully chosen. You don't have to do anything to enable it or use it. The options you've listed are meant for development or advanced users and are in the zigpy section of the config for that exact reason. If they are to be documented, it must be in the zigpy documentation, not ZHA's.

erkr · 2024-05-03T13:17:29Z

I agree with the goal of no config😊. But due the lack of documentation it got hard to discriminate developer options from user options. So it was just question. Thanks for clarifying 👍

Update zha.markdown with OTA update rewrite

Hedda · 2024-05-03T14:11:28Z

OK I have now given it a more serious attempt at a rewrite, including separating the UI part from the YAML configuration part.

50f9fe3

Please re-review this now.

Again, as mentioned above, I did not specifically mention that OTA for IKEA is disabled by default, but feel free to change that.

cremor · 2024-05-03T15:40:00Z

I think it's a weird choice to document Ikea as supported, but don't document it as disabled by default. But if the devs want it that way then it's ok.
Other than that it looks good, thanks.

erkr · 2024-05-03T20:57:34Z

My remarks are processed very well👍

erkr · 2024-05-11T17:37:56Z

I think it's a weird choice to document Ikea as supported, but don't document it as disabled by default.

I saw your remark and wondered:

ZHA reports all my Ikea devices as up to date now. But I know several are really outdated.
Is that because IKEA is disabled by default?
Is the reason because several issue are reports of failed updates with IKEA devices? That would be a valid choice, but then I agree with you to please mention that in the documentation!

@cremor can you shed a light on this please 🙏

cremor · 2024-05-11T17:59:00Z

ZHA reports all my Ikea devices as up to date now. But I know several are really outdated.
Is that because IKEA is disabled by default?

I think so, yes.

Is the reason because several issue are reports of failed updates with IKEA devices? That would be a valid choice, but then I agree with you to please mention that in the documentation!

I don't know the reason, I'm not a ZHA dev. I just noticed that it's disabled by default:
https://github.com/zigpy/zigpy/blob/038d57b9430ebc9e0f9c1c106440f7d27161f4e7/zigpy/config/defaults.py#L26

erkr · 2024-05-11T19:23:03Z

@cremor thanks!
Whatever the reason is to default IkEA by false, that should, IMHO, be documented.
If the reason is that it doesn't work, that is good to know

Hedda · 2024-05-12T07:54:02Z

I think it's a weird choice to document Ikea as supported, but don't document it as disabled by default. But if the devs want it that way then it's ok.
Other than that it looks good, thanks.

Whatever the reason is to default IkEA by false, that should, IMHO, be documented.

Regardless, such information can be could be updated in a seperate pull request. I hate to see the merger of this PR delayed further due to debate over that. As it is this PR does not change the info about that in the ZHA docs so it should still be accepable to merge as-is, then someone else can create a new PR dedicated for that, which would also help clearify that specifically. That is, I do not think that discussion should be a showstopper for this specific pull request.

erkr · 2024-05-12T11:37:20Z

I agree that publishing 'as is' is preferred above delay

Update section about Zigbee OTA for ZHA

ae9b255

Update section about Zigbee OTA for ZHA

Hedda requested review from dmulcahey, Adminiuga and puddly as code owners September 13, 2023 12:00

home-assistant bot added the current This PR goes into the current branch label Sep 13, 2023

home-assistant bot assigned Hedda Sep 13, 2023

home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Sep 13, 2023

This was referenced Sep 13, 2023

Update OTA section in README.md zigpy/zigpy#1243

Open

Conflicting information on THIRDREALITY device compatibility for OTA updates #28198

Closed

Merge branch 'current' into patch-94

cbd7a36

Hedda removed their assignment Nov 24, 2023

Hedda added 2 commits December 5, 2023 14:38

Merge branch 'current' into patch-94

516920f

Merge branch 'current' into patch-94

5882c71

Hedda requested a review from TheJulianJES as a code owner March 11, 2024 13:17

puddly reviewed Mar 11, 2024

View reviewed changes

source/_integrations/zha.markdown Outdated Show resolved Hide resolved

puddly requested changes Mar 12, 2024

View reviewed changes

home-assistant bot marked this pull request as draft March 12, 2024 19:38

cremor mentioned this pull request Mar 22, 2024

ZHA "OTA firmware updates" section is outdated #32003

Open

cremor reviewed Mar 22, 2024

View reviewed changes

source/_integrations/zha.markdown Outdated Show resolved Hide resolved

Hedda added 2 commits March 25, 2024 10:00

Merge branch 'current' into patch-94

a1eae36

Update zha.markdown

d62e4aa

Hedda marked this pull request as ready for review March 25, 2024 09:33

home-assistant bot requested a review from puddly March 25, 2024 09:33

Merge branch 'current' into patch-94

3c6646f

Hedda mentioned this pull request Apr 30, 2024

ZHA firmware update from file #31727

Closed

Merge branch 'current' into patch-94

3c2d673

erkr reviewed May 3, 2024

View reviewed changes

source/_integrations/zha.markdown Outdated Show resolved Hide resolved

source/_integrations/zha.markdown Outdated Show resolved Hide resolved

Hedda marked this pull request as draft May 3, 2024 13:15

Update zha.markdown with OTA update rewrite

50f9fe3

Update zha.markdown with OTA update rewrite

Merge branch 'current' into patch-94

e077a36

Hedda marked this pull request as ready for review May 3, 2024 14:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update ZHA section about Zigbee OTA #28895

Update ZHA section about Zigbee OTA #28895

Hedda commented Sep 13, 2023 •

edited

home-assistant bot commented Sep 13, 2023

Hedda commented Oct 12, 2023 •

edited

netlify bot commented Mar 11, 2024 •

edited

puddly left a comment

home-assistant bot commented Mar 12, 2024

Hedda commented Mar 25, 2024 •

edited

erkr left a comment

erkr left a comment •

edited

puddly commented May 3, 2024

erkr commented May 3, 2024 •

edited

Hedda commented May 3, 2024 •

edited

cremor commented May 3, 2024

erkr commented May 3, 2024 •

edited

erkr commented May 11, 2024 •

edited

cremor commented May 11, 2024

erkr commented May 11, 2024 •

edited

Hedda commented May 12, 2024 •

edited

erkr commented May 12, 2024

Update ZHA section about Zigbee OTA #28895

Are you sure you want to change the base?

Update ZHA section about Zigbee OTA #28895

Conversation

Hedda commented Sep 13, 2023 • edited

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Sep 13, 2023

Hedda commented Oct 12, 2023 • edited

netlify bot commented Mar 11, 2024 • edited

✅ Deploy Preview for home-assistant-docs ready!

puddly left a comment

Choose a reason for hiding this comment

home-assistant bot commented Mar 12, 2024

Hedda commented Mar 25, 2024 • edited

erkr left a comment

Choose a reason for hiding this comment

erkr left a comment • edited

Choose a reason for hiding this comment

puddly commented May 3, 2024

erkr commented May 3, 2024 • edited

Hedda commented May 3, 2024 • edited

cremor commented May 3, 2024

erkr commented May 3, 2024 • edited

erkr commented May 11, 2024 • edited

cremor commented May 11, 2024

erkr commented May 11, 2024 • edited

Hedda commented May 12, 2024 • edited

erkr commented May 12, 2024

Hedda commented Sep 13, 2023 •

edited

Hedda commented Oct 12, 2023 •

edited

netlify bot commented Mar 11, 2024 •

edited

Hedda commented Mar 25, 2024 •

edited

erkr left a comment •

edited

erkr commented May 3, 2024 •

edited

Hedda commented May 3, 2024 •

edited

erkr commented May 3, 2024 •

edited

erkr commented May 11, 2024 •

edited

erkr commented May 11, 2024 •

edited

Hedda commented May 12, 2024 •

edited