-
-
Notifications
You must be signed in to change notification settings - Fork 36.3k
Change ZHA strings for incorrect adapter state #158021
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
Change ZHA strings for incorrect adapter state #158021
Conversation
|
Hey there @dmulcahey, @Adminiuga, @puddly, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates ZHA repair strings to better handle incorrect adapter states beyond just multiprotocol firmware. The updated messaging covers scenarios where adapters may be stuck in the bootloader or have Thread firmware installed, providing clearer guidance for users experiencing these issues.
Key Changes:
- Broadened error description from "multiprotocol firmware detected" to "incorrect state" to cover bootloader issues
- Updated user guidance to include unplugging the adapter as a first troubleshooting step
- Changed titles from "multiprotocol firmware detected" to "adapter in incorrect state"
NoRi2909
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As "multiprotocol" is not a name and will be translated, it should not be capitalized.
Co-authored-by: Norbert Rittel <[email protected]>
Co-authored-by: Norbert Rittel <[email protected]>
Proposed change
This changes the ZHA string for the "incorrect firmware installed" repair to be more broad and also cover the state of the adapter being stuck in the bootloader or just having Thread firmware installed.
Specifically "multiprotocol" firmware is mentioned now, which is rarely the case.
Background
Currently, there's a (rare) issue where ZBT can get stuck in the bootloader after a firmware update.
Due to recent changes in the flasher library, we currently no longer try to get the adapter out of that state.
Goal
The goal of this changed string is just to avoid user confusion if they get stuck in this state after installing a firmware update. Users shouldn't need to be confused about multiprotocol firmware suddenly being installed, or the update having installed some wrong firmware in general, so that's why this is changed to a more relaxed "Incorrect state" error that also encompasses the "stuck in bootloader" state.
Future
In the future, we should have both (1) a fix for the device getting stuck in the bootloader and likely (2) a method to get the device out of the bootloader if possible (but only if we don't risk bricking the device if there's incorrect firmware installed when there's bootloader triggers).
As soon as these underlying issues are fixed (in another major HA release), this string will be updated again to just show "Incorrect firmware installed", but avoid the explicit mention of multiprotocol.
Images of updated repair dialogs
(Not sure why the font is a bit weird on my instance right now. Maybe recent Core/Frontend changes, as I'm also seeing this for other repairs. Not a result of the changes from this PR though.)
Alternatives
Alternatively, I've also thought about adding another repair/translation that's just shown if the device is stuck in the bootloader. Then, we'd have one variant for incorrect firmware and one for the adapter being in the bootloader.
I think adding that might be a bit too much for a patch release, so I've opted for this variant, for now.
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: