21b53b51a4
* Update OpenTherm Gateway docs to reflect the rewrite to a component. * Address review findings.
2.3 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | OpenTherm Gateway Hub | Control your OpenTherm Gateway from Home Assistant. | 2018-10-07 16:23 | true | false | true | true | opentherm.png | Hub | 0.81 | Local Push |
The opentherm_gw component is used to control the OpenTherm Gateway from Home Assistant.
When enabled, this component will automatically add it's climate entity to Home Assistant.
{% linkable_title Configuration %}
# Example configuration.yaml entry
opentherm_gw:
device: /dev/ttyUSB0
{% configuration %}
device:
description: "Path to OpenTherm Gateway device as supported by PySerial."
required: true
type: string
climate:
description: "Settings for the opentherm_gw climate entity."
required: false
type: map
keys:
name:
description: "The name for the device within Home Assistant."
required: false
type: string
default: "OpenTherm Gateway"
precision:
description: "The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are 0.1, 0.5 and 1.0."
required: false
type: float
default: "0.5 for Celsius and 1.0 for Fahrenheit."
floor_temperature:
description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to True to override Home Assistant and round to the lower value according to the configured precision."
required: false
type: boolean
default: false
{% endconfiguration %}
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.
{% linkable_title Example %}
A full configuration example with the OpenTherm Gateway connected to a remote host running ser2net looks like the one below.
# Full example configuration.yaml entry
opentherm_gw:
device: socket://otgw.example.org:2345
climate:
name: Thermostat
precision: 0.5
floor_temperature: True