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

Namespaces

 binary_sensor
 
 button
 
 climate
 
 config_flow
 
 const
 
 entity
 
 select
 
 sensor
 
 switch
 

Classes

class  OpenThermGatewayHub
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry config_entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None options_updated (HomeAssistant hass, ConfigEntry entry)
 
None register_services (HomeAssistant hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CLIMATE_SCHEMA
 
 CONFIG_SCHEMA
 
list PLATFORMS
 

Detailed Description

Support for OpenTherm Gateway devices.

Function Documentation

◆ async_setup()

bool homeassistant.components.opentherm_gw.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the OpenTherm Gateway component.

Definition at line 166 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.opentherm_gw.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry 
)
Set up the OpenTherm Gateway component.

Definition at line 111 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.opentherm_gw.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Cleanup and disconnect from gateway.

Definition at line 455 of file __init__.py.

◆ options_updated()

None homeassistant.components.opentherm_gw.options_updated ( HomeAssistant  hass,
ConfigEntry  entry 
)
Handle options update.

Definition at line 105 of file __init__.py.

◆ register_services()

None homeassistant.components.opentherm_gw.register_services ( HomeAssistant  hass)
Register services for the component.

Definition at line 192 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 70 of file __init__.py.

◆ CLIMATE_SCHEMA

homeassistant.components.opentherm_gw.CLIMATE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_PRECISION): vol.In(
4  [PRECISION_TENTHS, PRECISION_HALVES, PRECISION_WHOLE]
5  ),
6  vol.Optional(CONF_FLOOR_TEMP, default=False): cv.boolean,
7  }
8 )

Definition at line 73 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.opentherm_gw.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: cv.schema_with_slug_keys(
4  {
5  vol.Required(CONF_DEVICE): cv.string,
6  vol.Optional(CONF_CLIMATE, default={}): CLIMATE_SCHEMA,
7  vol.Optional(CONF_NAME): cv.string,
8  }
9  )
10  },
11  extra=vol.ALLOW_EXTRA,
12 )

Definition at line 82 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.opentherm_gw.PLATFORMS
Initial value:
1 = [
2  Platform.BINARY_SENSOR,
3  Platform.BUTTON,
4  Platform.CLIMATE,
5  Platform.SELECT,
6  Platform.SENSOR,
7  Platform.SWITCH,
8 ]

Definition at line 95 of file __init__.py.