From a93886f2e92c11b2d7c38793c89412456196552d Mon Sep 17 00:00:00 2001 From: cgtobi Date: Tue, 24 Mar 2020 13:02:19 +0100 Subject: [PATCH] Add Netatmo webhook event examples (#12494) * Add examples * Fix liniks and wording * Add link to official event types. * Add door tag link * Fix workding * Reword stuff * Update source/_integrations/netatmo.markdown Co-Authored-By: Franck Nijhof * Update netatmo.markdown * Add another example Co-authored-by: Franck Nijhof --- source/_integrations/netatmo.markdown | 90 +++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 6 deletions(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 24e50cfe73d..16cd34fbe5b 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 @@ -70,21 +71,98 @@ 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, [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, 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 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. + +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 + 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 +``` + +{% endraw %} + +Example: + +{% raw %} + +```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 +``` + +{% 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 %}