jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-21 18:36:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/nest.markdown

22 KiB
Raw Blame History

title, description, ha_category, ha_iot_class, ha_release, ha_config_flow, ha_codeowners, ha_domain
title description ha_category ha_iot_class ha_release ha_config_flow ha_codeowners ha_domain
Nest Instructions on how to integrate Nest into Home Assistant.
Hub
Binary Sensor
Camera
Climate
Sensor
Cloud Push 0.7 true
@awarecan
@allenporter
nest

The nest integration allows you to integrate your Google Nest devices in Home Assistant. This integration uses the Smart Device Management API and Google's Cloud Pubsub to efficiently listen for changes in device state or other events.

There is currently support for the following device types within Home Assistant:

This integration continues to support the Legacy Works With Nest API which is not accepting new users. The documentation for this API is at the bottom of this page so existing users can keep using it.

Overview: Supported Devices

Home Assistant is integrated with the following devices through the SDM API:

  • Thermostat Devices
    • Every thermostat is exposed as a climate entity
    • Temperature and Humidity sensors each have a sensor entity
    • Example devices: All Google Nest Thermostat models
  • Display, Camera, and Doorbell Devices
    • The camera live stream is available as a camera entity
    • Example devices: All Google Nest Cam models, Google Nest Hello Video Doorbell, Google Nest Hub Max

You are in control of the information and capabilities exposed to Home Assistant. You can authorize a single device, multiple devices, or different levels of functionality such as motion events, live streams, for any particular device. The integration is flexible enough to adapt based on what you allow.

Others devices like Smoke and CO Alarms or Security systems are not currently supported by the SDM API.

Account Setup

You will need to follow the instructions in Device Access Registration to authorize access to your devices. Follow these steps in the Quick Start Guide:

  • Accept the Terms of Service.
  • Pay a fee (currently US$5).
  • Register in the Device Access Console to get a project_id.
  • Authorize your Google Account and create OAuth credentials to get a client_id and client_secret.
It is currently not possible to share/be invited to a home with a G-Suite account. Make sure that you pay the fee with an account that has access to your devices.

Then you need to configure a Pub/Sub subscriber following the SDM API Event isntructions under Device Access: Events though not using a service account. The basic steps are:

Additionally, Home Assistant must be configured with a URL (e.g., external exposed http, Nabu Casa, etc). When setting up the OAuth credentials, make sure the Home Assistant URL is in the list of Authorized redirect URIs, so the redirect back to Home Assistant can get an OAuth authorization code.

Follow all of the instructions in Device Access: Quick Start Guide carefully as it is easy to make a configuration mistake that is difficult to debug. It is recommended to exercise the entire guide, including the command to test out the API, to make sure that it is working before configuring Home Assistant.

When you get to the steps about configuring events make sure to follow guide under Events that configures the Pub/Sub subscription from the Google Cloud console. Make sure to use the topic name from the device access console and a unique subscription ID in the cloud console. Note the message retention is how long messages will queue while offline, so keep that short (e.g., under an hour) to avoid a potentially large backlog of updates.

Configuration


```yaml
# Example configuration.yaml entry
nest:
  client_id: CLIENT_ID
  client_secret: CLIENT_SECRET
  project_id: PROJECT_ID    # ("Project ID" in the Device Access Console)
  subscriber_id: projects/.../subscriptions/SUBSCRIBER_ID # ("Subscription ID" in Google Cloud Console. Replace with full path.)

{% configuration %} client_id: description: Your Device Access or Nest developer client ID. required: true type: string client_secret: description: Your Device Access or Nest developer client secret. required: true type: string project_id: description: Your Device Access Project ID. This enables the SDM API. required: false type: string subscriber_id: description: Full path for the Pub/sub Subscription ID used to receive events. This is required to use the SDM API. type: string required: false {% endconfiguration %}

Device Setup

Once your developer account is set up and you have a valid nest entry in configuration.yaml , you need to connect devices with the following steps:

  1. From the Home Assistant front-end, navigate to Configuration then Integrations. Under Set up a new integration locate 'Nest'.
  2. You should get redirected to Google to choose an account. This should be the same developer account you configured above.
  3. The Google Nest permissions screen will allow you to choose which devices to configure. You can leave out any device that you do not wish to use with Home Assistant.
  4. You will get redirected back to another account selection page.
  5. Confirm you want to allow persistent access to Home Assistant.

Troubleshooting

  • See No URL Available for guidance on setup issues related to URLs.

  • For trouble with the SDM API OAuth authorization flow with Google, see Troubleshooting which includes guidance for errors like redirect_uri_mismatch where Google needs to know about your external URL

  • You can see stats about your subscriber in the Cloud Console which includes # of messages that have yet to be acknowledged. This can tell you if the publisher is working, or if the subscriber is working. You can also View Messages to see any pending messages. Many old unacknowledged messages may indicate the subscriber is not working properly.

  • To aid in diagnosing subscriber problems or camera stream issues it may help to turn up verbose logging by adding some or all of these to your configuration.yaml depending on where you are having trouble:


logger:
  default: info
  logs:
    homeassistant.components.nest: debug
    homeassistant.components.nest.climate_sdm: debug
    homeassistant.components.nest.camera_sdm: debug
    homeassistant.components.nest.sensor_sdm: debug
    google_nest_sdm: debug
    google_nest_sdm.device: debug
    google_nest_sdm.device_manager: debug
    google_nest_sdm.google_nest_subscriber: debug
    google_nest_sdm.event: debug
    google.cloud.pubsub_v1: debug
    google.cloud.pubsub_v1.subscriber._protocol.streaming_pull_manager: debug
    google.cloud.pubsub_v1.subscriber._protocol.streaming_pull_manager: debug

Camera

All Google Nest Cam models, Google Nest Hello Video Doorbell, Google Nest Hub Max expose a CameraLiveStream via the SDM API, which returns a RTSP live stream which can be viewed from Home Assistant.

Given a camera named Front Yard then the camera is created with a name such as camera.front_yard.

Climate

All Google Nest Thermostat models are exposed as a climate entity that use the Thermostat Traits in the SDM API. State changes to the thermostat are reported to Home Assistant through the Cloud Pubsub subscriber.

Given a thermostat named Upstairs then the climate entity is created with a name such as climate.upstairs

Sensor

All Google Nest Thermostat models have traits exposed from the SDM API. The initial values of the sensors are fetched on startup, then updated regularly using the Cloud Pubsub subscriber. The following traits are supported with sensors:

Given a thermostat named Upstairs then sensors are created with names such as sensor.upstairs_temperature or sensor.upstairs_humidity.

Legacy Works With Nest API

This section contains instructions for the Legacy Works with Nest API.

New users are not currently able to set up a Works With Nest Developer account. The documentation is preserved here for existing users of the API.
Click here for documentation for the Legacy Works with Nest API

The Nest integration is the main integration to integrate all Nest related platforms. To connect Nest, you will have to sign up for a developer account and get a client_id and client_secret.

There is currently support for the following device types within Home Assistant:

Setting up developer account

  1. Visit Nest Developers, and sign in. Create an account if you don't have one already.
  2. Fill in account details:
  • The "Company Information" can be anything. We recommend using your name.
  1. Submit changes
  2. Click "Products" at top of page.
  3. Click "Create New Product"
  4. Fill in details:
  • Product name must be unique. We recommend [email] - Home Assistant.
  • The description, users, URLs can all be anything you want.
  • Leave the "Redirect URI" Field blank
  1. For permissions check every box and if it's an option select the read/write option. Note: there are important permissions under the "Other Permissions" category. If you are only adding a thermostat, do not just select the permissions under "Thermostat". You still need to check the boxes under "Other Permissions" in order to give you access to features like away mode, ETA, structure read/write, and postal code.
  • The description requires a specific format to be accepted.
    • Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
  1. Click "Create Product"
  2. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as client_id and client_secret below.
  3. Add the Nest integration to your configuration.yaml and restart Home Assistant. Then, go to Configuration > Integrations and select CONFIGURE next to Nest. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up.

Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible.

Configuration

# Example configuration.yaml entry
nest:
  client_id: CLIENT_ID
  client_secret: CLIENT_SECRET

# Example configuration.yaml entry to show only devices at your vacation and primary homes
nest:
  client_id: CLIENT_ID
  client_secret: CLIENT_SECRET
  structure:
    - Vacation
    - Primary

{% configuration %} client_id: description: Your Nest developer client ID. required: true type: string client_secret: description: Your Nest developer client secret. required: true type: string structure: description: The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account. required: false type: list {% endconfiguration %}

Service set_away_mode

You can use the service nest/set_away_mode to set the structure(s) to "Home" or "Away".

Service data attribute Optional Description
away_mode no String, must be away or home.
structure yes String, will default to all configured Nest structures if not specified.

Examples:

# Example script to set away, no structure specified so will execute for all
script:
  nest_set_away:
    sequence:
      - service: nest.set_away_mode
        data:
          away_mode: away

# Example script to set home, structure specified
script:
  nest_set_home:
    sequence:
      - service: nest.set_away_mode
        data:
          away_mode: home
          structure:
            - Apartment

Service set_eta

You can use the service nest/set_eta to set or update the estimated time of arrival window. Calling this service will automatically set the structure(s) to "Away". Structures must have an associated Nest thermostat in order to use ETA function.

Service data attribute Optional Description
eta no Time period, estimated time of arrival from now.
eta_window yes Time period, estimated time of arrival window. Default is 1 minute.
trip_id yes String, unique ID for the trip. Default is auto-generated using a timestamp. Using an existing trip_id will update that trip's ETA.
structure yes String, will default to all configured Nest structures if not specified.

Examples:

# Example script to set ETA, no structure specified so will execute for all
script:
  nest_set_eta:
    sequence:
      - service: nest.set_eta
        data:
          eta: 00:10:30
          trip_id: Leave Work

# Example script to update ETA and specify window, structure specified
script:
  nest_update_eta:
    sequence:
      - service: nest.set_eta
        data:
          eta: 00:11:00
          eta_window: 00:05
          trip_id: Leave Work
          structure:
            - Apartment

Service cancel_eta

You can use the service nest/cancel_eta to cancel an existing estimated time of arrival window. Structures must have an associated Nest thermostat in order to use ETA function.

Service data attribute Optional Description
trip_id no String, unique ID for the trip. Using an existing trip_id will update that trip's ETA.
structure yes String, will default to all configured Nest structures if not specified.

Examples:

# Example script to cancel ETA, no structure specified so will execute for all
script:
  nest_cancel_eta:
    sequence:
      - service: nest.cancel_eta
        data:
          trip_id: Leave Work

# Example script to cancel ETA, structure specified
script:
  nest_cancel_eta:
    sequence:
      - service: nest.cancel_eta
        data:
          trip_id: Leave Work
          structure:
            - Apartment

Troubleshooting

  • For trouble with the SDM API OAuth authorization flow with Google, see Troubleshooting which includes guidance for errors like redirect_uri_mismatch where Google needs to know about your external URL.

  • If you're getting rickrolled by the Legacy API instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option.

Platforms

You must have the Nest component configured to use the platforms below.

Binary Sensor

The nest binary sensor platform lets you monitor various states of your Nest devices.

You must have the Nest component configured to use these sensors. The binary sensors will be setup if the nest integration is configured and the required configuration for the nest binary sensor is set.

Configuration

To enable binary sensors and customize which sensors are setup, you can extend the Nest component configuration in your configuration.yaml file with the following settings:

# Example configuration.yaml entry
nest:
  binary_sensors:
    monitored_conditions:
      - 'fan'
      - 'target'

By default all binary sensors for your available Nest devices will be monitored. Leave monitored_conditions blank to disable all binary sensors for the Nest component.

{% configuration %} monitored_conditions: description: States to monitor. required: false type: list {% endconfiguration %}

The following conditions are available by device:

  • Nest Home:
    • away
  • Nest Thermostat:
    • online
    • fan
    • is_using_emergency_heat
    • is_locked
    • has_leaf
  • Nest Protect:
    • online
  • Nest Camera:
    • online
    • motion_detected
    • person_detected
    • sound_detected

Camera

The nest platform allows you to watch still frames from a video stream (not live stream) of your Nest camera in Home Assistant.

The Legacy API integration allows you to watch still frames from a video stream (not live stream). The Legacy API also supports the camera.turn_on and camera.turn_off services.

Nest Camera supports the camera.turn_on and camera.turn_off services since the 0.75 release.

Climate

The nest climate platform lets you control a thermostat from Nest.

Please note due to limitations with the European Nest Thermostat E, integration with Home Assistant for that thermostat is not possible.

Sensor

The nest sensor platform lets you monitor sensors connected to your Nest devices.

The sensors will be setup if the nest integration is configured and the required configuration for the nest sensor is set.

Configuration

To enable sensors and customize which sensors are setup, you can extend the Nest component configuration in your configuration.yaml file with the following settings:

# Example configuration.yaml entry
nest:
  sensors:
    monitored_conditions:
      - 'temperature'
      - 'target'

By default all sensors for your available Nest devices will be monitored. Leave monitored_conditions blank to disable all sensors for the Nest component.

{% configuration %} monitored_conditions: description: States to monitor. required: false type: list {% endconfiguration %}

The following conditions are available by device:

  • Nest Home:
    • eta: Estimated time of arrival.
    • security_state: ok or deter. Security State. Only available when Nest Camera exists.
  • Nest Thermostat:
    • humidity
    • preset_mode
    • temperature
    • target
    • hvac_state: The currently active state of the HVAC system, heat, cool or off (previously heating, cooling or off).
  • Nest Protect:
    • co_status: Ok, Warning or Emergency
    • smoke_status: Ok, Warning or Emergency
    • battery_health: Ok or Replace
    • color_status: gray, green, yellow or red. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
  • Nest Camera: none

Security State

This feature is not designed to transform your Home Assistant into a security system, neither Home Assistant nor Nest are liable for damages, or consequential damages of any character arising as a result of use this feature.

This feature does not depend on the Nest Secure alarm system and is not a reflection of the status of that system, nor does it react to state changes in that system.

This feature uses a new Nest Security API. You may need to change your "Product" permission setting to include Security State Read. After this permission change, you may need to re-authorize your client.

If a Nest Cam detects the presence of a person (see person_detected in binary_sensor.nest while the structure is in away mode (see away in binary_sensor.nest, the structure enters deter mode.

A deter state is re-evaluated after several minutes and relaxed to ok if no further person_detected events have occurred.

The security_state automatically switches to ok when the structure state is home.