home-assistant / home-assistant.io

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

Nest troubleshooting doc uplift #30685

Closed nayfield closed 6 months ago

nayfield commented 8 months ago

Feedback

Using a new HA yellow device, the one missing part in the documentation was that I needed to (at the very last step connected to home-assistant.io) modify my URL to be http and include the port number (it was https without a port number, eg 443).

Once I did that, it gave me a blank screen ... but when going back to the original HA window it said auth completed.

URL

https://www.home-assistant.io/integrations/nest/#troubleshooting

Version

No response

Additional information

No response

home-assistant[bot] commented 8 months ago

Hey there @allenporter, mind taking a look at this feedback as it has been labeled with an integration (nest) you are listed as a code owner for? Thanks!

Code owner commands Code owners of `nest` can trigger bot actions by commenting: - `@home-assistant close` Closes the feedback. - `@home-assistant rename Awesome new title` Renames the feedback. - `@home-assistant reopen` Reopen the feedback. - `@home-assistant unassign nest` Removes the current integration label and assignees on the feedback, add the integration domain after the command. - `@home-assistant add-label needs-more-information` Add a label (needs-more-information) to the feedback. - `@home-assistant remove-label needs-more-information` Remove a label (needs-more-information) on the feedback.
allenporter commented 8 months ago

I am not sure what you're referring to. You shouldn't need to modify any urls, unless you're saying your my home assistnat configuration was incorrect already for some reason?

nayfield commented 8 months ago

Steps to reproduce:

  1. buy a yellow device and set it up per the instructions
  2. after install, but before it boots the first time, give it's mac a static DHCP mapping with domain name ha.my-domain.com
  3. boot system ... you can access it at http://ha.my-domain.com:8123/ 4, follow guide exactly
  4. Last step, after confirming granular device access, then account access, you are sent to the home-assistant.io redirect uri
  5. On that page, it tells that it will redirect you to https://ha.my-domain.com/ if you hit the button.

if you don't click the pencil while on home-assistant.io and change to http and add the port, it won't work, because the yellow is not listening on port 443.

If you do change, you get a blank white screen. (it actually worked, but there's no sign of that until you close the empty tab and go back to where you started)

I can reproduce this all day long

On Sat, Jan 6, 2024 at 4:36 PM Allen Porter @.***> wrote:

I am not sure what you're referring to. You shouldn't need to modify any urls, unless you're saying your my home assistnat configuration was incorrect already for some reason?

— Reply to this email directly, view it on GitHub https://github.com/home-assistant/home-assistant.io/issues/30685#issuecomment-1879835763, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMAGFADVBYSSEXWIKSOV3DYNG7XRAVCNFSM6AAAAABBPZTHG2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNZZHAZTKNZWGM . You are receiving this because you authored the thread.Message ID: @.***>

home-assistant[bot] commented 8 months ago

Hey there @home-assistant/core, mind taking a look at this feedback as it has been labeled with an integration (my) you are listed as a code owner for? Thanks!

Code owner commands Code owners of `my` can trigger bot actions by commenting: - `@home-assistant close` Closes the feedback. - `@home-assistant rename Awesome new title` Renames the feedback. - `@home-assistant reopen` Reopen the feedback. - `@home-assistant unassign my` Removes the current integration label and assignees on the feedback, add the integration domain after the command. - `@home-assistant add-label needs-more-information` Add a label (needs-more-information) to the feedback. - `@home-assistant remove-label needs-more-information` Remove a label (needs-more-information) on the feedback.
allenporter commented 8 months ago

Adding my label. I think the issue is not specific to the nest instructions, but more about initial my home assistant setup. It should give you the right url from the start.

allenporter commented 8 months ago

(Perhaps this is not a documentation issue though)

MartinHjelmare commented 8 months ago

Did you configure My Home Assistant before setting up the nest integration?

https://my.home-assistant.io/

nayfield commented 8 months ago

I did not. The docs for my seemed to say it doesn't need configuration, and it's not mentioned in the nest instructions.

Maybe the fix for this ticket is :

  1. Link to a pre req doc that shows you how to verify my is set up correctly and you can link back to my from .io

  2. Explain the blank page after oauth dance and that you should close it (or have the local my oauth endpoint print a success message)

On Sun, Jan 7, 2024, 4:02 AM Martin Hjelmare @.***> wrote:

Did you configure My Home Assistant before setting up the nest integration?

https://my.home-assistant.io/

— Reply to this email directly, view it on GitHub https://github.com/home-assistant/home-assistant.io/issues/30685#issuecomment-1879998557, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMAGFBRUOGORTF3MGRZSCDYNJQDVAVCNFSM6AAAAABBPZTHG2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNZZHE4TQNJVG4 . You are receiving this because you authored the thread.Message ID: @.***>

MartinHjelmare commented 8 months ago

Normally there shouldn't be any blank page if the oauth2 flow works correctly. I don't know if the nest integration has some peculiar behavior here but I'm guessing it was a result from the missing config for My Home Assistant.

It is mentioned in the nest instructions that My Home Assistant is used. It should link more clearly to it up front and be explicit that it's need to be configured correctly, though.

nayfield commented 8 months ago

It should link more clearly to it up front and be explicit that it's need to be configured correctly, though.

agreed. https://www.home-assistant.io/integrations/my/ seems to imply there's no configuration (just add my: ) ...

It could be as simple as:

On Sun, Jan 7, 2024 at 1:51 PM Martin Hjelmare @.***> wrote:

Normally there shouldn't be any blank page if the oauth2 flow works correctly. I don't know if the nest integration has some peculiar behavior here but I'm guessing it was a result from the missing config for My Home Assistant.

It is mentioned in the nest instructions that My Home Assistant is used. It should link more clearly to it up front and be explicit that it's need to be configured correctly, though.

— Reply to this email directly, view it on GitHub https://github.com/home-assistant/home-assistant.io/issues/30685#issuecomment-1880140649, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMAGFEXYIEIHWTE7HDGDHDYNLVCPAVCNFSM6AAAAABBPZTHG2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBQGE2DANRUHE . You are receiving this because you authored the thread.Message ID: @.***>

allenporter commented 8 months ago

To be fair, it starts with "To add the Nest integration to your Home Assistant, use this My Button" so that step should mean things are setup properly. Though I realize you can just start the integration install without going through the docs.

The change to use my home assistant happened to update how oauth works across all integrations, not specific to nest really. Perhaps we want to change an include file or doc template for all oauth integrations if this isn't clear?

MartinHjelmare commented 8 months ago

Yes, a template that we can include for these integrations sounds good. 👍

github-actions[bot] commented 6 months 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.