Document opentherm_gw device support. (#11163)

This commit is contained in:
mvn23 2019-11-27 14:14:58 +01:00 committed by Charles Garwood
parent 2e17215a48
commit 7f40cbc41e

View File

@ -19,7 +19,7 @@ The following device types are currently supported within Home Assistant:
- Climate - Climate
- Sensor - Sensor
This integration will add a single `climate` entity and multiple `sensor` and `binary_sensor` entities to Home Assistant for each configured gateway. This integration will add a single `climate` entity to Home Assistant for each configured gateway. Each gateway also has a collection of `sensor` and `binary_sensor` entities, which are disabled by default. These can be enabled from the `Devices` panel in the `Configuration` page of the web interface.
<div class='note'> <div class='note'>
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
@ -183,7 +183,7 @@ The value you provide here will be used with the GPIO `home` (5) and `away` (6)
## Sensors ## Sensors
The following `sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. The following `sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. All `sensor` entities are disabled by default.
<p class='note'> <p class='note'>
Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values. Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values.
</p> </p>
@ -383,7 +383,7 @@ Not all boilers and thermostats properly support all OpenTherm features, so not
## Binary Sensors ## Binary Sensors
The following `binary_sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. The following `binary_sensor` entities will be created for each configured gateway. The `entity_id` of every sensor will have a suffix containing the `gateway_id` of the gateway to which it belongs. All `binary_sensor` entities are disabled by default.
<p class='note'> <p class='note'>
Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values. Not all boilers and thermostats properly support all OpenTherm features, so not all of the sensors will have useful values.
</p> </p>