OpenTherm Gateway for Home Assistant (built-in integration)

About

OpenTherm Gateway is a built-in integration that connects Home Assistant to an OpenTherm Gateway boiler interface. It communicates locally and is set up in the UI by entering a path or URL and an ID. It provides a climate entity along with binary sensors, sensors, buttons, switches and selects covering items such as flame status, fault indications, water pressure, pump running time and hot water flow rate. Buttons cancel a room setpoint override or heat hot water once, and a select controls the hot water override. Actions cover resetting the gateway, setting the clock, hot water setpoint, outside temperature and setback temperature, changing GPIO and LED modes, and sending a transparent command. Options include floor temperature, read and set precision, and the temporary setpoint override mode.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Climate
Switches
Sensors

Setting it up

It is added under Settings, Devices and services, with Add integration.

Connect

Path or URL
ID

After setup

Floor Temperature
Read Precision
Set Precision
Temporary Setpoint Override Mode

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsAir pressure fault, Control type, Cooling, Diagnostic indication, Fault indication, Flame, Gas fault, Hot water, Hot water system type, Ignore transitions, Low water pressure, Outside temperature correction, and 14 more
ButtonsCancel room setpoint override, Heat hot water once
SelectsHot water override
SensorsCentral heating water pressure, Central heating pump running time, Central heating pump start count, Clock speed, Cooling control signal, Exhaust temperature, Firmware build, Firmware version, Hot water burner running time, Hot water burner start count, Hot water flow rate, Hot water override mode, and 32 more

Actions

Reset gatewayResets the OpenTherm Gateway.Fields: Gateway ID
Send transparent commandFields: Gateway ID, Argument, Command
Set central heating overrideSets the central heating override option on the gateway. When overriding the control setpoint (via a 'Set control setpoint' action with a value other than 0), the gateway automatically enables the central heating override to start heating. This action can then be used to control the central heating override status. To return control of the central heating to the thermostat, use the 'Set control setpoint' action with temperature value 0. You will only need this if you are writing your own software thermostat.Fields: Central heating override, Gateway ID
Set clockSets the clock and day of the week on the connected thermostat.Fields: Date, Gateway ID, Time
Set control setpointSets the central heating control setpoint override on the gateway. You will only need this if you are writing your own software thermostat.Fields: Gateway ID, Temperature
Set gpio modeChanges the function of the GPIO pins of the gateway.Fields: Gateway ID, ID, Mode
Set hot water overrideSets the domestic hot water enable option on the gateway.Fields: Domestic hot water override, Gateway ID
Set hot water setpointSets the domestic hot water setpoint on the gateway.Fields: Gateway ID, Temperature
Set LED modeChanges the function of the LEDs of the gateway.Fields: Gateway ID, ID, Mode
Set max modulationOverrides the maximum relative modulation level. You will only need this if you are writing your own software thermostat.Fields: Gateway ID, Level
Set outside temperatureProvides an outside temperature to the thermostat. If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect.Fields: Gateway ID, Temperature
Set setback temperatureConfigures the setback temperature to be used with the GPIO away mode function.Fields: Gateway ID, Temperature