From 9f3a37c9fcceac41cce4c6448b92102b05ad0162 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 16:20:21 +0100 Subject: [PATCH 1/9] Add examples --- source/_integrations/netatmo.markdown | 35 +++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 24e50cfe73d6..42501099c823 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -23,6 +23,7 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Climate](#climate) - [Sensor](#sensor) +- [Webhooks](#webhooks) ## Configuration @@ -88,3 +89,37 @@ The smart indoor and outdoor cameras, as well as the smart smoke alarm, send ins To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web. To achieve this you can either use your Nabu Casa account or ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations. + +Example: +```yaml +# Example automation for webhooks based Netatmo events +- alias: Netatmo event example + description: "Count all events pushed by the Netatmo API" + trigger: + - event_data: {} + event_type: netatmo_event + platform: event + action: + - data: {} + entity_id: counter.event_counter + service: counter.increment +``` + +Example: +```yaml +# Example automation +- alias: Motion at home + description: 'Motion detected at home' + trigger: + - event_type: netatmo_event + platform: event + event_data: + type: movement + action: + - data_template: + message: > + {{ trigger.event.data["data"]["message"] }} + at {{ trigger.event.data["data"]["home_name"] }} + title: Netatmo event + service: persistent_notification.create +``` From ce6a0029248d26ef9841ee99f598201be1337e78 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 16:48:37 +0100 Subject: [PATCH 2/9] Fix liniks and wording --- source/_integrations/netatmo.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 42501099c823..3fbb867db8de 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -71,22 +71,22 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo ## Camera -The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This integration allows you to view the current live stream created by the Camera. +The `netatmo` camera platform is consuming the information provided by a [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera. This integration allows you to view the current live stream created by the camera. ## Climate -The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This integration allows you to view the current temperature and setpoint. +The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) or [Netatmo Smart Radiator Valve](https://www.netatmo.com/en-gb/energy/additional-valve). This integration allows you to view the current temperature and control the setpoint. ## Sensor -The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a -[Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) device. +The `netatmo` sensor platform is consuming the information provided by a [Netatmo Smart Home Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a +[Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device. ## Webhooks -The smart indoor and outdoor cameras, as well as the smart smoke alarm, send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. +The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. -To be able to receive events from Netatmo, your Home Assistant instance needs to be accessible from the web. To achieve this you can either use your Nabu Casa account or ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). +To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations. From 651230741877580d62c0a40d1319b39348ae9189 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 16:56:53 +0100 Subject: [PATCH 3/9] Add link to official event types. --- source/_integrations/netatmo.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 3fbb867db8de..6372d72ae19d 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -90,6 +90,8 @@ To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), you Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations. +You can find the available event types at the [official Netatmo API documentation](https://dev.netatmo.com/apidocumentation/security#events). + Example: ```yaml # Example automation for webhooks based Netatmo events From 7051202929fd6c1486a0d7a601db46ee3f79d5cb Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 17:04:29 +0100 Subject: [PATCH 4/9] Add door tag link --- source/_integrations/netatmo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 6372d72ae19d..98eb83234caa 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -84,7 +84,7 @@ The `netatmo` sensor platform is consuming the information provided by a [Netatm ## Webhooks -The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. +The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, [Smart Door and Window Sensors](https://www.netatmo.com/en-gb/security/cam-indoor/tag), as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). From ae3bbcd8342d955aeeded3588250b29434c30654 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 17:10:33 +0100 Subject: [PATCH 5/9] Fix workding --- source/_integrations/netatmo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 98eb83234caa..249bf8287734 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -86,7 +86,7 @@ The `netatmo` sensor platform is consuming the information provided by a [Netatm The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, [Smart Door and Window Sensors](https://www.netatmo.com/en-gb/security/cam-indoor/tag), as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. -To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). +To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)) in either case. Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations. From 507fd864dab0f1c25a422a22a4c624ef21715f83 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 17:12:20 +0100 Subject: [PATCH 6/9] Reword stuff --- source/_integrations/netatmo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 249bf8287734..c05427fb79a0 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -86,7 +86,7 @@ The `netatmo` sensor platform is consuming the information provided by a [Netatm The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, [Smart Door and Window Sensors](https://www.netatmo.com/en-gb/security/cam-indoor/tag), as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant. -To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)) in either case. +To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations. From f4b3943536df9b725ea770dadeb52c2dab6b44e9 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 17:32:53 +0100 Subject: [PATCH 7/9] Update source/_integrations/netatmo.markdown Co-Authored-By: Franck Nijhof --- source/_integrations/netatmo.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index c05427fb79a0..00f5db05d210 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -108,6 +108,9 @@ Example: ``` Example: + +{% raw %} + ```yaml # Example automation - alias: Motion at home @@ -124,4 +127,3 @@ Example: at {{ trigger.event.data["data"]["home_name"] }} title: Netatmo event service: persistent_notification.create -``` From e2b4c6804ad7c24d245001cca228c5f22b97d693 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Mon, 23 Mar 2020 17:34:08 +0100 Subject: [PATCH 8/9] Update netatmo.markdown --- source/_integrations/netatmo.markdown | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 00f5db05d210..841f019ba12e 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -93,6 +93,9 @@ Events coming in from Netatmo will be available as an event in Home Assistant an You can find the available event types at the [official Netatmo API documentation](https://dev.netatmo.com/apidocumentation/security#events). Example: + +{% raw %} + ```yaml # Example automation for webhooks based Netatmo events - alias: Netatmo event example @@ -107,6 +110,8 @@ Example: service: counter.increment ``` +{% endraw %} + Example: {% raw %} @@ -127,3 +132,6 @@ Example: at {{ trigger.event.data["data"]["home_name"] }} title: Netatmo event service: persistent_notification.create +``` + +{% endraw %} From 071e03d0587d43a47ffa48ed201b284c6039e066 Mon Sep 17 00:00:00 2001 From: cgtobi Date: Tue, 24 Mar 2020 11:41:43 +0100 Subject: [PATCH 9/9] Add another example --- source/_integrations/netatmo.markdown | 31 +++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 841f019ba12e..16cd34fbe5b7 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -135,3 +135,34 @@ Example: ``` {% endraw %} + +Example: + +{% raw %} + +```yaml +# Example automation +- alias: door or window open or movement + description: 'Notifies which door or window is open or was moved' + trigger: + - event_type: netatmo_event + platform: event + event_data: + type: tag_open + - event_type: netatmo_event + platform: event + event_data: + type: tag_big_move + - event_type: netatmo_event + platform: event + event_data: + type: tag_small_move + action: + - data_template: + message: > + {{ trigger.event.data["data"]["message"] }} + title: Netatmo event + service: persistent_notification.create +``` + +{% endraw %}