home_io_control.water_heater Namespace Reference

Functions
	_validate_water_heater_kind (config)
	_inject_companion_ids (config)
	_companion_config (companion, config)
	to_code (config)

Variables
list	DEPENDENCIES = ["home_io_control"]
	IOHomeWaterHeater = home_io_control_ns.class_("IOHomeWaterHeater", water_heater.WaterHeater, cg.Component)
	IOHomeDhwEnergySensor = home_io_control_ns.class_("IOHomeDhwEnergySensor", sensor.Sensor, cg.Component)
	IOHomeDhwBinarySensor
	IOHomeDhwBoostSwitch = home_io_control_ns.class_("IOHomeDhwBoostSwitch", switch.Switch, cg.Component)
	DhwReading = IOHomeDhwBinarySensor.enum("Reading", is_class=True)
str	CONF_HEAT_PUMP_RUNNING = "heat_pump_running"
str	CONF_ELECTRIC_BACKUP_RUNNING = "electric_backup_running"
str	CONF_BOOST = "boost"
tuple	_BINARY_COMPANIONS
	CONFIG_SCHEMA

Function Documentation

_companion_config()

_companion_config ( companion, config )

protected

A companion's config, grouped under the entity's ESPHome sub-device unless it names its own.

Definition at line 132 of file water_heater.py.

_inject_companion_ids()

_inject_companion_ids ( config )

protected

Declare the auto-generated companion IDs during validation (ESPHome 2026.x StaticVector sizing).

The opt-in companions (sensors and the boost switch) are schemas of their own, whose IDs are declared by
their GenerateID.

Definition at line 89 of file water_heater.py.

_validate_water_heater_kind()

_validate_water_heater_kind ( config )

protected

Require io_device_type, and a kind that is read and commanded as a water heater.

The water heater's frames (family-0x00 register reads, the mode write, a target EXECUTE) go only to a
device whose kind carries the WATER_HEATER capability, so the kind must be known at codegen time.

Definition at line 68 of file water_heater.py.

to_code()

to_code

(

config

)

Definition at line 139 of file water_heater.py.

Here is the call graph for this function:

Variable Documentation

_BINARY_COMPANIONS

tuple home_io_control.water_heater._BINARY_COMPANIONS

protected

Initial value:

=  (
    (CONF_HEAT_PUMP_RUNNING, DhwReading.HEAT_PUMP),
    (CONF_ELECTRIC_BACKUP_RUNNING, DhwReading.ELECTRIC_BACKUP),
)

Definition at line 62 of file water_heater.py.

CONF_BOOST

str home_io_control.water_heater.CONF_BOOST = "boost"

Definition at line 59 of file water_heater.py.

CONF_ELECTRIC_BACKUP_RUNNING

str home_io_control.water_heater.CONF_ELECTRIC_BACKUP_RUNNING = "electric_backup_running"

Definition at line 58 of file water_heater.py.

CONF_HEAT_PUMP_RUNNING

str home_io_control.water_heater.CONF_HEAT_PUMP_RUNNING = "heat_pump_running"

Definition at line 57 of file water_heater.py.

CONFIG_SCHEMA

home_io_control.water_heater.CONFIG_SCHEMA

Definition at line 98 of file water_heater.py.

DEPENDENCIES

list home_io_control.water_heater.DEPENDENCIES = ["home_io_control"]

Definition at line 47 of file water_heater.py.

DhwReading

home_io_control.water_heater.DhwReading = IOHomeDhwBinarySensor.enum("Reading", is_class=True)

Definition at line 55 of file water_heater.py.

IOHomeDhwBinarySensor

home_io_control.water_heater.IOHomeDhwBinarySensor

Initial value:

=  home_io_control_ns.class_(
    "IOHomeDhwBinarySensor", binary_sensor.BinarySensor, cg.Component
)

Definition at line 51 of file water_heater.py.

IOHomeDhwBoostSwitch

home_io_control.water_heater.IOHomeDhwBoostSwitch = home_io_control_ns.class_("IOHomeDhwBoostSwitch", switch.Switch, cg.Component)

Definition at line 54 of file water_heater.py.

IOHomeDhwEnergySensor

home_io_control.water_heater.IOHomeDhwEnergySensor = home_io_control_ns.class_("IOHomeDhwEnergySensor", sensor.Sensor, cg.Component)

Definition at line 50 of file water_heater.py.

IOHomeWaterHeater

home_io_control.water_heater.IOHomeWaterHeater = home_io_control_ns.class_("IOHomeWaterHeater", water_heater.WaterHeater, cg.Component)

Definition at line 49 of file water_heater.py.