mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 13:26:54 +00:00
🚜 Merges/Redirect Nest component pages (#8574)
* 🚜 Merges/Redirect Nest component pages * ✏️ Fix error
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
519c4515d0
commit
d5e2f5e00c
@ -1,60 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Binary Sensor"
|
||||
description: "Instructions on how to integrate Nest binary sensors within Home Assistant."
|
||||
date: 2016-01-26 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# 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](/components/nest/).
|
||||
|
||||
{% 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
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Camera"
|
||||
description: "Instructions on how to integrate Nest cameras into Home Assistant."
|
||||
date: 2016-12-03 08:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.34
|
||||
ha_iot_class: "Cloud Poll"
|
||||
---
|
||||
|
||||
The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use this camera. The `nest` camera will automatically be setup when you do.
|
||||
</p>
|
||||
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Thermostat"
|
||||
description: "Instructions on how to integrate Nest thermostats within Home Assistant."
|
||||
date: 2015-03-23 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Climate
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The `nest` climate component will automatically be setup when you do. Please note due to limitations with the European Nest Thermostat E, integration with Home Assistant for that thermostat is not possible.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
||||
@ -8,28 +8,45 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
- Camera
|
||||
- Climate
|
||||
- Sensor
|
||||
featured: true
|
||||
ha_iot_class: "Cloud Push"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.nest/
|
||||
- /components/camera.nest/
|
||||
- /components/climate.nest/
|
||||
- /components/sensor.nest/
|
||||
---
|
||||
|
||||
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
### {% linkable_title Setting up developer account %}
|
||||
|
||||
1. Visit [Nest Developers](https://developers.nest.com/), 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.
|
||||
* The "Company Information" can be anything. We recommend using your name.
|
||||
3. Submit changes
|
||||
4. Click "[Products](https://developers.nest.com/products)" at top of page.
|
||||
5. Click "[Create New Product](https://developers.nest.com/products/new)"
|
||||
6. 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
|
||||
* 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
|
||||
7. 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.
|
||||
* 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.
|
||||
8. Click "Create Product"
|
||||
9. 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.
|
||||
10. Add the Nest component 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.
|
||||
@ -177,3 +194,149 @@ script:
|
||||
### {% linkable_title Troubleshooting %}
|
||||
|
||||
- If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) 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.
|
||||
|
||||
## {% linkable_title Platforms %}
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use the platforms below.
|
||||
<p>
|
||||
|
||||
## {% linkable_title Binary Sensor %}
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# 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](/components/nest/).
|
||||
|
||||
{% 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
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
|
||||
|
||||
<p class='note'>
|
||||
The `nest` camera will automatically be setup when you do.
|
||||
</p>
|
||||
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
|
||||
## {% linkable_title Climate %}
|
||||
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
<p class='note'>
|
||||
Please note due to limitations with the European Nest Thermostat E, integration with Home Assistant for that thermostat is not possible.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# 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](/components/nest/).
|
||||
|
||||
{% 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](#security-state). Only available when Nest Camera exists.
|
||||
- Nest Thermostat:
|
||||
- humidity
|
||||
- operation\_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
|
||||
|
||||
## {% linkable_title Security State %}
|
||||
|
||||
<p class='note warning'>
|
||||
This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You 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](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,
|
||||
nor does it react to state changes in that system.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
This feature uses a new [Nest Security API](https://developers.nest.com/documentation/cloud/security-guide).
|
||||
You may need to change your ["Product"](https://developers.nest.com/products) permission setting to include `Security State Read`.
|
||||
After this permission change, you may need to re-authorize your client.
|
||||
</p>
|
||||
|
||||
If a Nest Cam detects the presence of a person (see `person_detected` in [binary_sensor.nest](#binary-sensor) while the structure is in `away` mode (see `away` in [binary_sensor.nest](#binary-sensor), 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`.
|
||||
@ -1,82 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Nest Sensor"
|
||||
description: "Instructions on how to integrate Nest sensors within Home Assistant."
|
||||
date: 2016-01-13 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest.png
|
||||
ha_category: Sensor
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
# 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](/components/nest/).
|
||||
|
||||
{% 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](#security-state). Only available when Nest Camera exists.
|
||||
- Nest Thermostat:
|
||||
- humidity
|
||||
- operation\_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
|
||||
|
||||
## {% linkable_title Security State %}
|
||||
|
||||
<p class='note warning'>
|
||||
This feature is not designed to transfer your Home Assistant to a security system, neither Home Assistant nor Nest be liable to You 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](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,
|
||||
nor does it react to state changes in that system.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
This feature uses a new [Nest Security API](https://developers.nest.com/documentation/cloud/security-guide).
|
||||
You may need to change your ["Product"](https://developers.nest.com/products) permission setting to include `Security State Read`.
|
||||
After this permission change, you may need to re-authorize your client.
|
||||
</p>
|
||||
|
||||
If a Nest Cam detects the presence of a person (see `person_detected` in [binary_sensor.nest](/components/binary_sensor.nest/)) while the structure is in `away` mode (see `away` in [binary_sensor.nest](/components/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`.
|
||||
Loading…
x
Reference in New Issue
Block a user