Improvements for nest documentation based on recent user issues (#18599)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Allen Porter 2021-07-24 13:13:29 -07:00 committed by GitHub
parent adafb29f8d
commit 0da413743c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -35,6 +35,10 @@ There is currently support for the following device types within Home Assistant:
This integration supports two Nest APIs. The SDM API is the new primary API that accepts new users. The Legacy Works With Nest API is not accepting new users, but the documentation still exists at the bottom of the page so existing users can keep using it. This integration supports two Nest APIs. The SDM API is the new primary API that accepts new users. The Legacy Works With Nest API is not accepting new users, but the documentation still exists at the bottom of the page so existing users can keep using it.
</div> </div>
Google applies strict [Redirect URI validation
rules](https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation) to keep your login
credentials secure. In practice, this means that you must access Home Assistant *over SSL* and a *public top-level domain*. See the documentation on [Securing](/docs/configuration/securing/) or [Troubleshooting](#troubleshooting), and note that you don't need actually need to enable remote access.
## Overview: Supported Devices ## Overview: Supported Devices
Home Assistant is integrated with the following devices through the SDM API: Home Assistant is integrated with the following devices through the SDM API:
@ -247,8 +251,8 @@ everything, however, you can leave out any feature you do not wish to use with H
domain (such as .com or .org)* or *must use a valid domain that is a valid top private domain*. This means that you domain (such as .com or .org)* or *must use a valid domain that is a valid top private domain*. This means that you
may need to change the URL you use to access Home Assistant in order to access your devices. may need to change the URL you use to access Home Assistant in order to access your devices.
- A convienent solution is to use [Nabu Casa](https://www.nabucasa.com/) - See [Securing](https://www.home-assistant.io/docs/configuration/securing/) Home Assistant for convient solutions e.g. [Nabu Casa](https://www.nabucasa.com/) or Duck DNS.
- There are subtle rules for what types of URLs are allowed, namely that they must use a publicly known hostname, though your Home Assistant ports do not need to be exposed to the internet. - There are subtle [rules](https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation) for what types of URLs are allowed, namely that they must use SSL and a publicly known hostname, though your Home Assistant ports do not need to be exposed to the internet.
- You can use any publicly known hostname you own - You can use any publicly known hostname you own
- As a hack, you can use hosts tricks to temporarily assign a public hostname to your Home Assistant IP address. - As a hack, you can use hosts tricks to temporarily assign a public hostname to your Home Assistant IP address.
@ -275,13 +279,14 @@ logger:
homeassistant.components.nest.climate_sdm: debug homeassistant.components.nest.climate_sdm: debug
homeassistant.components.nest.camera_sdm: debug homeassistant.components.nest.camera_sdm: debug
homeassistant.components.nest.sensor_sdm: debug homeassistant.components.nest.sensor_sdm: debug
homeassistant.helpers.config_entry_flow: debug
homeassistant.helpers.config_entry_oauth2_flow: debug
google_nest_sdm: debug google_nest_sdm: debug
google_nest_sdm.device: debug google_nest_sdm.device: debug
google_nest_sdm.device_manager: debug google_nest_sdm.device_manager: debug
google_nest_sdm.google_nest_subscriber: debug google_nest_sdm.google_nest_subscriber: debug
google_nest_sdm.event: debug google_nest_sdm.event: debug
google.cloud.pubsub_v1: debug google.cloud.pubsub_v1: debug
google.cloud.pubsub_v1.subscriber._protocol.streaming_pull_manager: debug
``` ```
## Camera ## Camera