home-assistant / home-assistant.io

:blue_book: Home Assistant User documentation
https://www.home-assistant.io
Other
4.96k stars 7.27k forks source link

Unclear integration instructions #23146

Closed kekonn closed 2 years ago

kekonn commented 2 years ago

Feedback

When checking out this integration, I noticed that it asks for account credentials. But it is entirely unclear which credentials have to be entered? Those of the selected hub? Overkiz credentials? If the latter, where do I go to create that account?

URL

https://www.home-assistant.io/integrations/overkiz/#tahoma-switch

Version

No, it's not at the bottom

Additional information

No response

probot-home-assistant[bot] commented 2 years ago

Hey there @imicknl, @vlebourl, @tetienne, mind taking a look at this feedback as it has been labeled with an integration (overkiz) you are listed as a code owner for? Thanks! (message by CodeOwnersMention)

tetienne commented 2 years ago

Hi, I don’t get what’s unclear. When you want to install the component, you got this message:

The Overkiz platform is used by various vendors like Somfy (Connexoon / TaHoma), Hitachi (Hi Kumo), Rexel (Energeasy Connect) and Atlantic (Cozytouch). Enter your application credentials and select your hub.

And more specifically:

Enter your application credentials and select your hub.

It’s pretty clear IMO. If you own a Tahoma, then you have the associated application on your phone. Same for Rexel, Cozytouch, etc. So just use the credentials for your dedicated application

kekonn commented 2 years ago

I was on the fence if it was more like the Tuya integration. For someone who might not be familiar with all the listed platforms and how they work, it's not entirely clear.

A suggestion for the wording of the second sentence:

Enter the credentials of the application you selected in the Hub list:

EDIT: And perhaps also make the hub selection the first item on the config screen so that it reads:

iMicknl commented 2 years ago

@kekonn we are adding local support for the Somfy TaHoma hubs, which will change the config flow. I will take your concerns into account. For now; the new flow will first ask for the hub, and in a separate prompt it will ask the additional details.

github-actions[bot] commented 2 years ago

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved. If this issue is still relevant, please let us know by leaving a comment 👍 This issue has now has been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.