Add restart note to Legrand Home+ Control docs (#17507)

This commit is contained in:
Franck Nijhof 2021-04-18 14:06:15 +02:00 committed by GitHub
parent eebbe6134d
commit 81e252fe04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,14 +20,15 @@ This integration works against the Home+ Control API, which is one of the many A
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/). 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 - Light switches
- Power outlets - Power outlets
In both cases, the devices are modeled as on/off switches within Home Assistant. 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: This integration has been tested to work with the following range of Legrand products
- Valena Next™ with Netatmo
- Valena Next™ with Netatmo
## Authentication ## Authentication
@ -66,21 +67,18 @@ subscription_key:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
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.
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 %} {% include integrations/config_flow.md %}
## API Nomenclature ## API Nomenclature
Within the context of the Home+ Control API you may come across the following terms: 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). - *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. - *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. - *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. - *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*. Other devices that are mentioned in the API, but that are not currently supported by this integration are: *remotes* (wireless switches), *heaters* and *automations*.