Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecoal_boiler Namespace Reference

Namespaces

 sensor
 
 switch
 

Functions

bool setup (HomeAssistant hass, ConfigType hass_config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary AVAILABLE_PUMPS
 
dictionary AVAILABLE_SENSORS
 
 CONFIG_SCHEMA
 
string DATA_ECOAL_BOILER = f"data_{DOMAIN}"
 
string DEFAULT_PASSWORD = "admin"
 
string DEFAULT_USERNAME = "admin"
 
string DOMAIN = "ecoal_boiler"
 
 SENSOR_SCHEMA
 
 SWITCH_SCHEMA
 

Detailed Description

Support to control ecoal/esterownik.pl coal/wood boiler controller.

Function Documentation

◆ setup()

bool homeassistant.components.ecoal_boiler.setup ( HomeAssistant  hass,
ConfigType  hass_config 
)
Set up global ECoalController instance same for sensors and switches.

Definition at line 86 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.ecoal_boiler._LOGGER = logging.getLogger(__name__)
private

Definition at line 22 of file __init__.py.

◆ AVAILABLE_PUMPS

dictionary homeassistant.components.ecoal_boiler.AVAILABLE_PUMPS
Initial value:
1 = {
2  "central_heating_pump": "Central heating pump",
3  "central_heating_pump2": "Central heating pump2",
4  "domestic_hot_water_pump": "Domestic hot water pump",
5 }

Definition at line 33 of file __init__.py.

◆ AVAILABLE_SENSORS

dictionary homeassistant.components.ecoal_boiler.AVAILABLE_SENSORS
Initial value:
1 = {
2  "outdoor_temp": "Outdoor temperature",
3  "indoor_temp": "Indoor temperature",
4  "indoor2_temp": "Indoor temperature 2",
5  "domestic_hot_water_temp": "Domestic hot water temperature",
6  "target_domestic_hot_water_temp": "Target hot water temperature",
7  "feedwater_in_temp": "Feedwater input temperature",
8  "feedwater_out_temp": "Feedwater output temperature",
9  "target_feedwater_temp": "Target feedwater temperature",
10  "fuel_feeder_temp": "Fuel feeder temperature",
11  "exhaust_temp": "Exhaust temperature",
12 }

Definition at line 41 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.ecoal_boiler.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_HOST): cv.string,
6  vol.Optional(CONF_PASSWORD, default=DEFAULT_PASSWORD): cv.string,
7  vol.Optional(CONF_SENSORS, default={}): SENSOR_SCHEMA,
8  vol.Optional(CONF_SWITCHES, default={}): SWITCH_SCHEMA,
9  vol.Optional(CONF_USERNAME, default=DEFAULT_USERNAME): cv.string,
10  }
11  )
12  },
13  extra=vol.ALLOW_EXTRA,
14 )

Definition at line 70 of file __init__.py.

◆ DATA_ECOAL_BOILER

string homeassistant.components.ecoal_boiler.DATA_ECOAL_BOILER = f"data_{DOMAIN}"

Definition at line 25 of file __init__.py.

◆ DEFAULT_PASSWORD

string homeassistant.components.ecoal_boiler.DEFAULT_PASSWORD = "admin"

Definition at line 28 of file __init__.py.

◆ DEFAULT_USERNAME

string homeassistant.components.ecoal_boiler.DEFAULT_USERNAME = "admin"

Definition at line 27 of file __init__.py.

◆ DOMAIN

string homeassistant.components.ecoal_boiler.DOMAIN = "ecoal_boiler"

Definition at line 24 of file __init__.py.

◆ SENSOR_SCHEMA

homeassistant.components.ecoal_boiler.SENSOR_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(
4  CONF_MONITORED_CONDITIONS, default=list(AVAILABLE_SENSORS)
5  ): vol.All(cv.ensure_list, [vol.In(AVAILABLE_SENSORS)])
6  }
7 )

Definition at line 62 of file __init__.py.

◆ SWITCH_SCHEMA

homeassistant.components.ecoal_boiler.SWITCH_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_MONITORED_CONDITIONS, default=list(AVAILABLE_PUMPS)): vol.All(
4  cv.ensure_list, [vol.In(AVAILABLE_PUMPS)]
5  )
6  }
7 )

Definition at line 54 of file __init__.py.