From 4cab7fb249829f99fb6e11827b02d962e80319e6 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 16 Oct 2018 20:57:35 +0200 Subject: [PATCH] Update Nest component configuration variable (#6732) * Update Nest component configuration variable * Minor changes --- .../_components/binary_sensor.nest.markdown | 9 ++++--- source/_components/nest.markdown | 19 +++++++++---- source/_components/sensor.nest.markdown | 11 +++++--- .../_components/sensor.nest_weather.markdown | 27 ++++++++++++------- 4 files changed, 44 insertions(+), 22 deletions(-) diff --git a/source/_components/binary_sensor.nest.markdown b/source/_components/binary_sensor.nest.markdown index 6949c6d2b55..3303cabdff4 100644 --- a/source/_components/binary_sensor.nest.markdown +++ b/source/_components/binary_sensor.nest.markdown @@ -33,9 +33,12 @@ nest: 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 variables: - -- **monitored_conditions** array (*Optional*): States to monitor. +{% configuration %} +monitored_conditions: + description: States to monitor. + required: false + type: list +{% endconfiguration %} The following conditions are available by device: diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 9a22aeba843..e935935d043 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -55,11 +55,20 @@ nest: - Primary ``` -Configuration variables: - -- **client_id** (*Required*): Your Nest developer client ID. -- **client_secret** (*Required*): Your Nest developer client secret. -- **structure** (*Optional*): The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account. +{% 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 %} ### {% linkable_title Services %} diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index 99d40e63016..801198eb46b 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -13,7 +13,6 @@ 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.

@@ -23,6 +22,7 @@ You must have the [Nest component](/components/nest/) configured to use these se ## {% 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: @@ -34,9 +34,12 @@ nest: 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 variables: - -- **monitored_conditions** array (*Optional*): States to monitor. +{% configuration %} +monitored_conditions: + description: States to monitor. + required: false + type: list +{% endconfiguration %} The following conditions are available by device: diff --git a/source/_components/sensor.nest_weather.markdown b/source/_components/sensor.nest_weather.markdown index 971e72cb162..a8ab4c4c460 100644 --- a/source/_components/sensor.nest_weather.markdown +++ b/source/_components/sensor.nest_weather.markdown @@ -16,7 +16,6 @@ ha_iot_class: "Cloud Polling" **This platform is currently not available. It's possible that `nest_weather` will be removed in the future.**

- The `nest` weather sensor platform let you monitor current weather conditions based on the location of your [Nest](https://nest.com) thermostat.

@@ -32,12 +31,20 @@ sensor: - 'weather_temperature' ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): States to monitor. - - 'weather_temperature' - - 'weather_humidity' - - 'weather_condition' - - 'wind_speed' - - 'wind_direction' - +{% configuration %} +monitored_conditions: + description: States to monitor. + required: true + type: list + keys: + weather_temperature: + description: The current temperture + weather_humidity: + description: The current humidity + weather_condition: + description: The weather conditions + wind_speed: + description: The wind speed + wind_direction: + description: The wind direction +{% endconfiguration %}