From 81e252fe046999cd22ca74232a5d650e2263258c Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sun, 18 Apr 2021 14:06:15 +0200 Subject: [PATCH] Add restart note to Legrand Home+ Control docs (#17507) --- .../_integrations/home_plus_control.markdown | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/source/_integrations/home_plus_control.markdown b/source/_integrations/home_plus_control.markdown index 4ad115acc66..79d8af2c5fb 100644 --- a/source/_integrations/home_plus_control.markdown +++ b/source/_integrations/home_plus_control.markdown @@ -13,21 +13,22 @@ ha_platforms: - switch --- -The Home+ Control integration platform allows you to control a range of Legrand in-wall switches and power outlets that have smart home functionality thanks to their "with Netatmo" capabilities. +The Home+ Control integration platform allows you to control a range of Legrand in-wall switches and power outlets that have smart home functionality thanks to their "with Netatmo" capabilities. This integration works against the Home+ Control API, which is one of the many APIs offered through the [*Works with Legrand*](https://developer.legrand.com/) program. The API is capable of managing "Legrand/Btcino with Netatmo" devices, such as light switches, power outlets and rolling shutters. The devices that this API can manage are offered in different designs across different countries. The details of these can be found [here](https://developer.legrand.com/solutions/wiring-devices-with-netatmo/). -This Home+ Control integration for Home Assistant currently has support for the following devices: +This Home+ Control integration for Home Assistant currently has support for the following devices: + - Light switches - Power outlets In both cases, the devices are modeled as on/off switches within Home Assistant. -This integration has been tested to work with the following range of Legrand products: -- Valena Next™ with Netatmo +This integration has been tested to work with the following range of Legrand products +- Valena Next™ with Netatmo ## Authentication @@ -66,26 +67,23 @@ subscription_key: type: string {% endconfiguration %} - -At this point, you are now ready to add the Home+ Control integration to your Home Assistant instance as described in the [Configuration](#configuration) section. - +Restart Home Assistant after changing the YAML configuration. At this point, you are now ready to add the Home+ Control integration to your Home Assistant instance as described in the [Configuration](#configuration) section. {% include integrations/config_flow.md %} - ## API Nomenclature Within the context of the Home+ Control API you may come across the following terms: -* *Plant*: This is the term used to represent a *home* that holds the Legrand devices. In practice, a *plant* is represented by the *Legrand Home+ Control* gateway that acts as the central hub of the rest of the devices in the home network (uses Zigbee). -* *Module*: This is the term used to represent a generic device within the *plant*, i.e., a light, a plug, a remote, etc. -* *Light*: This is the term used to represent a light switch (or a micro-module). It is not modeled as your usual light entity because there are no brightness, color, etc. controls. It is modeled as an on/off switch. -* *Plug*: This is the term used to represent a power outlet. +- *Plant*: This is the term used to represent a *home* that holds the Legrand devices. In practice, a *plant* is represented by the *Legrand Home+ Control* gateway that acts as the central hub of the rest of the devices in the home network (uses Zigbee). +- *Module*: This is the term used to represent a generic device within the *plant*, i.e., a light, a plug, a remote, etc. +- *Light*: This is the term used to represent a light switch (or a micro-module). It is not modeled as your usual light entity because there are no brightness, color, etc. controls. It is modeled as an on/off switch. +- *Plug*: This is the term used to represent a power outlet. Other devices that are mentioned in the API, but that are not currently supported by this integration are: *remotes* (wireless switches), *heaters* and *automations*. ## API Limitations -As described in the [authentication](#authentication) section, this integration requires you to set up a subscription in the *Works with Legrand* platform. +As described in the [authentication](#authentication) section, this integration requires you to set up a subscription in the *Works with Legrand* platform. Currently, end-users only have access to the *Starter Kit* subscription which has a major limitation in the number of allowed API requests that are allowed - only 500 API calls per day (counter is reset at 00:00 every day). If this daily quota is ever exceeded, the API will report `403 Forbidden` HTTP responses.