diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 66d741a03ec..c0a97338ac4 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -8,10 +8,11 @@ ha_category: - Sensor - Climate - Camera -ha_release: '0.20' + - Light +ha_release: "0.20" ha_iot_class: Cloud Polling ha_codeowners: - - '@cgtobi' + - "@cgtobi" ha_config_flow: true ha_domain: netatmo --- @@ -22,8 +23,9 @@ There is currently support for the following device types within Home Assistant: - [Camera](#camera) - [Climate](#climate) +- [Light](#light) - [Sensor](#sensor) -- [Webhooks](#webhooks) +- [Webhook Events](#webhook-events) ## Configuration @@ -49,12 +51,16 @@ client_secret: **After the client_id and client_secret is added to your `configuration.yaml` you must enable Netatmo through the integrations page.** +Menu: **Configuration** -> **Integrations**. + ### Extra configuration of the integration Configuration of Netatmo public weather stations is offered from the front end. Enter the Netatmo integration and press the cogwheel. In the dialogue, it is possible to create, edit and remove public weather sensors. For each area a unique name has to be set along with an area to be covered and whether to display average or maximum values. +To edit an existing area simply enter its name and follow the dialog. + ### Get API and Secret Key To get your API credentials, you have to declare a new application in the [Netatmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular Netatmo account. @@ -83,12 +89,42 @@ The `netatmo` camera platform is consuming the information provided by a [Netatm 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. +## Light + +The `netatmo` light platform is consuming information provided by a [Netatmo Smart Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera and requires an active webhook. This integration allows you to turn on/off the flood lights. + ## Sensor The `netatmo` sensor platform is consuming the information provided by a [Netatmo Smart Home Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) a -[Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device or Netatmo Public Weather Stations. +[Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device or [Netatmo Public Weather Stations](https://weathermap.netatmo.com/). -## Webhooks +## Services + +### Set Schedule + +`set_schedule` + +Set the heating schedule. This requires an entity id and a schedule name. + +### Set Person Home + +`set_persons_home` + +Set a list of persons as at home. Person's name must match a name known by the Netatmo Smart Indoor Camera. + +### Set Person Away + +`set_person_away` + +Set a person away. If no person is set the home will be marked as empty. Person's name must match a name known by the Netatmo Smart Indoor Camera. + +### (Un-)Register Webhooks + +`register_webhook` and `unregister_webhook` + +Service to manually register and unregister the webhook. + +## Webhook Events 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. @@ -125,19 +161,19 @@ Example: ```yaml # Example automation for Netatmo Welcome - alias: Motion at home - description: 'Motion detected at home' + description: "Motion detected at home" trigger: - - event_type: netatmo_event - platform: event - event_data: - type: movement + - 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 + - data_template: + message: > + {{ trigger.event.data["data"]["message"] }} + at {{ trigger.event.data["data"]["home_name"] }} + title: Netatmo event + service: persistent_notification.create ``` {% endraw %} @@ -149,19 +185,19 @@ Example: ```yaml # Example automation for Netatmo Presence - alias: Motion at home - description: 'Motion detected at home' + description: "Motion detected at home" trigger: - - event_type: netatmo_event - platform: event - event_data: - type: human # other possible types: animal, vehicle + - event_type: netatmo_event + platform: event + event_data: + type: human # other possible types: animal, vehicle action: - - data_template: - message: > - {{ trigger.event.data["data"]["message"] }} - at {{ trigger.event.data["data"]["home_name"] }} - title: Netatmo event - service: persistent_notification.create + - data_template: + message: > + {{ trigger.event.data["data"]["message"] }} + at {{ trigger.event.data["data"]["home_name"] }} + title: Netatmo event + service: persistent_notification.create ``` {% endraw %} @@ -173,26 +209,32 @@ Example: ```yaml # Example automation - alias: door or window open or movement - description: 'Notifies which door or window is open or was moved' + 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 + - 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 + - data_template: + message: > + {{ trigger.event.data["data"]["message"] }} + title: Netatmo event + service: persistent_notification.create ``` {% endraw %} + +## Troubleshooting + +### Light + +If the lights show as unavailable the issue usually is that webhook is banned by Netatmo. To solve that [unregister](#un-register-webhooks) the webhook, go to the [Netatmo Developer Page](https://dev.netatmo.com/) to unban your webhook and then [register](#un-register-webhooks) the webhook.