Overkiz integration requires me to re-enter same password every couple of weeks about core

[home-assistant]

Hey there @iMicknl, @vlebourl, @tetienne, @nyroDev, @Tronix117, mind taking a look at this issue as it has been labeled with an integration (overkiz) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of overkiz can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Renames the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign overkiz Removes the current integration label and assignees on the issue, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

---

overkiz documentation
overkiz source
_{^{(message by IssueLinks)}}

[iMicknl]

Can you check for any error in your log files prior to reconfigure? Somfy has the habit of raising "Bad Credentials" when they are updating their servers or when they temporarily block an account. We haven't heard much of this behavior lately though, this was a big issue long time ago, but after some code changes and a more stable Somfy server this hasn't been reported anymore.

As a work around, if you 'reload your integration' it will use your cached password and log-in again.

Can you add your diagnostics? Which Somfy server (region?) do you use?

[knwpsk]

Hi @iMicknl
For sure. Next time it borks, I'll pause and capture whatever is needed.
Which log file(s)? Just open the main system log and look for Overkiz? Is that enough?

BTW when this happens, there's no choice to "reload" the integration, or I would have. On the Integrations page, Overkiz is at the top, and there's a button on it saying "reconfigure". When I click that, it asks for my (same, unchanged) password.

Also: When I click the integration > download diagnostics, nothing happens. Literally nothing. There's no download, nor any error message about it.

[knwpsk]

@iMicknl it happened again today.
In HA main view > Settings, I have an alert:

Clicking on that takes me to the "original" integration setup:

I stopped there and went to the Integrations page instead, where I see this box at the top asking me to "Reconfigure":

but that Reconfigure button takes me to the same setup.
The three-dot menu here has only one option, taking me to the integration's Documentation page.

Finally, lower down, in the normal list of my Integrations, Overkiz appears normally. I click it and it takes me to the Overkiz integration page. It tells me that Overkiz "needs attention":

On this page, the three-dot menu includes "download diagnostics" -- which like yesterday, is inoperable. It literally does nothing.
I tried "Reload", and it says the integration was reloaded successfully, but it doesn't fix the problem, still in the same state.

In my Core log, this is all I see:

Logger: homeassistant.components.overkiz
Source: helpers/update_coordinator.py:365
integration: Overkiz (documentation, issues)
First occurred: 4:42:14 AM (1 occurrences)
Last logged: 4:42:14 AM

Authentication failed while fetching device events data: Invalid authentication.


Please tell me if I can provide any more info -- and how/where to get it?
I'm leaving it in broken state for a while, to facilitate any further troubleshooting.

Thanks!

[iMicknl]

Can you turn on debug mode and share your event log prior to the invalid authentication? Which Somfy server (region?) do you use?

This is an error caused by the Somfy server ("Invalid authentication"), thus hard to solve on our side.

[knwpsk]

@iMicknl I turned on debug logging.
I assume you mean, now re-authorize the integration, and wait for it to happen again, so I get better logging - yes?

I'm in North America region.

[iMicknl]

@knwpsk yes! Can you include your diagnostics as well, after you are authenticated?

Since you mention North America, most likely this is your issue: #68620. It is a known bug with a work-around (disable polling).

[knwpsk]

Reauthenticated Overkiz/Somfy.
"Download Diagnostics" still doesn't work, no error, no popup, no download, silent failure.

So I restarted HA to see if that helped. No change, still no Diagnostics.

So I went to Core log, searched "Overkiz", and copied all of that into the attached file. Hope it's of some use.

---

I remember that "disable polling" thing from a couple of years ago when I first got this Somfy paperweight. I think I already disabled polling.

Uploading 20240611 1308 HA overkiz log extract.txt…

[iMicknl]

@knwpsk any message in your log when downloading diagnostics? If the log can't be downloaded due to an error, it should be in your log.

[knwpsk]

Yeah, when I try to download diagnostics, I see this in the core log:

Logger: homeassistant.components.websocket_api.http.connection
Source: components/websocket_api/connection.py:307
integration: Home Assistant WebSocket API ([documentation](https://www.home-assistant.io/integrations/websocket_api), [issues](https://github.com/home-assistant/core/issues?q=is%3Aissue+is%3Aopen+label%3A%22integration%3A+websocket_api%22))
First occurred: 2:55:19 PM (5 occurrences)
Last logged: 3:01:18 PM

[281472309454608] Error handling message: expected str for dictionary value @ data['path']. Got None (invalid_format) ****** from 127.0.0.1 (Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36)
[281472406289520] Error handling message: expected str for dictionary value @ data['path']. Got None (invalid_format) ****** from 192.168.86.37 (Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36)

[knwpsk]

@iMicknl two tangential things:

1. I noticed that the "download diagnostics" problem is happening with all of my integrations, not just Overkiz. Any help on how to troubleshoot that?? I'm lost.
2. I set up an Automation to notify me when Overkiz (or any other integration) goes into a bad state. The Trigger for this is an Event, and the event type is "repairs_issue_registry_updated". (Also added a condition: {{ trigger.event.data.action != 'remove' }}. I'm hoping this will catch the Overkiz thing more quickly. If you have any thoughts or suggestions on this I'd love to hear it.
   (This was a bit tricky and obscure to figure out; would be nice if HA natively had an option to "alert me" if any integration goes into a bad state.)

[knwpsk]

So... this is why I can't download diagnostics:
home-assistant/frontend#21061

[knwpsk]

@iMicknl
Diagnostics attached

config_entry-overkiz-501a0140c1ca0b0bd9df33af089479f4 (1).json

[iMicknl]

Thanks! Indeed, you only have RTS devices and we poll every 30 seconds, which is causing these errors.
Duplicate of #68620. Turn of polling should solve this for now.

[knwpsk]

aaah, ok
I remember doing this before, but I think I may have uninstalled/reinstalled the integration and forgot to re-set it.
So I have just changed this setting:

That's it?

(p.s. THANK YOU for your patience!)

[iMicknl]

Yes, this will fix it for now. Best fix would be a long term fix (tracked in #68620), but no ETA for now.