homeassistant.components.generic_thermostat.climate Namespace Reference

Classes
class	GenericThermostat

Functions
None	_async_setup_config (HomeAssistant hass, Mapping[str, Any] config, str|None unique_id, AddEntitiesCallback async_add_entities)
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_INITIAL_HVAC_MODE = "initial_hvac_mode"
string	CONF_KEEP_ALIVE = "keep_alive"
string	CONF_MAX_TEMP = "max_temp"
string	CONF_MIN_TEMP = "min_temp"
string	CONF_PRECISION = "precision"
string	CONF_TARGET_TEMP = "target_temp"
string	CONF_TEMP_STEP = "target_temp_step"
string	DEFAULT_NAME = "Generic Thermostat"
	PLATFORM_SCHEMA = CLIMATE_PLATFORM_SCHEMA.extend(PLATFORM_SCHEMA_COMMON.schema)
	PLATFORM_SCHEMA_COMMON
	VolDictType

Detailed Description

Adds support for generic thermostat units.

Function Documentation

_async_setup_config()

None homeassistant.components.generic_thermostat.climate._async_setup_config ( HomeAssistant  hass, Mapping[str, Any]  config, str | None  unique_id, AddEntitiesCallback  async_add_entities  )

private

Set up the generic thermostat platform.

Definition at line 151 of file climate.py.

async_setup_entry()

None homeassistant.components.generic_thermostat.climate.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize config entry.

Definition at line 123 of file climate.py.

async_setup_platform()

None homeassistant.components.generic_thermostat.climate.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the generic thermostat platform.

Definition at line 137 of file climate.py.

Variable Documentation

_LOGGER

homeassistant.components.generic_thermostat.climate._LOGGER = logging.getLogger(__name__)

private

Definition at line 74 of file climate.py.

CONF_INITIAL_HVAC_MODE

string homeassistant.components.generic_thermostat.climate.CONF_INITIAL_HVAC_MODE = "initial_hvac_mode"

Definition at line 78 of file climate.py.

CONF_KEEP_ALIVE

string homeassistant.components.generic_thermostat.climate.CONF_KEEP_ALIVE = "keep_alive"

Definition at line 79 of file climate.py.

CONF_MAX_TEMP

string homeassistant.components.generic_thermostat.climate.CONF_MAX_TEMP = "max_temp"

Definition at line 81 of file climate.py.

CONF_MIN_TEMP

string homeassistant.components.generic_thermostat.climate.CONF_MIN_TEMP = "min_temp"

Definition at line 80 of file climate.py.

CONF_PRECISION

string homeassistant.components.generic_thermostat.climate.CONF_PRECISION = "precision"

Definition at line 82 of file climate.py.

CONF_TARGET_TEMP

string homeassistant.components.generic_thermostat.climate.CONF_TARGET_TEMP = "target_temp"

Definition at line 83 of file climate.py.

CONF_TEMP_STEP

string homeassistant.components.generic_thermostat.climate.CONF_TEMP_STEP = "target_temp_step"

Definition at line 84 of file climate.py.

DEFAULT_NAME

string homeassistant.components.generic_thermostat.climate.DEFAULT_NAME = "Generic Thermostat"

Definition at line 76 of file climate.py.

PLATFORM_SCHEMA

homeassistant.components.generic_thermostat.climate.PLATFORM_SCHEMA = CLIMATE_PLATFORM_SCHEMA.extend(PLATFORM_SCHEMA_COMMON.schema)

Definition at line 120 of file climate.py.

PLATFORM_SCHEMA_COMMON

homeassistant.components.generic_thermostat.climate.PLATFORM_SCHEMA_COMMON

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_HEATER): cv.entity_id,
        vol.Required(CONF_SENSOR): cv.entity_id,
        vol.Optional(CONF_AC_MODE): cv.boolean,
        vol.Optional(CONF_MAX_TEMP): vol.Coerce(float),
        vol.Optional(CONF_MIN_DUR): cv.positive_time_period,
        vol.Optional(CONF_MIN_TEMP): vol.Coerce(float),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_COLD_TOLERANCE, default=DEFAULT_TOLERANCE): vol.Coerce(float),
        vol.Optional(CONF_HOT_TOLERANCE, default=DEFAULT_TOLERANCE): vol.Coerce(float),
        vol.Optional(CONF_TARGET_TEMP): vol.Coerce(float),
        vol.Optional(CONF_KEEP_ALIVE): cv.positive_time_period,
        vol.Optional(CONF_INITIAL_HVAC_MODE): vol.In(
            [HVACMode.COOL, HVACMode.HEAT, HVACMode.OFF]
        ),
        vol.Optional(CONF_PRECISION): vol.All(
            vol.Coerce(float),
            vol.In([PRECISION_TENTHS, PRECISION_HALVES, PRECISION_WHOLE]),
        ),
        vol.Optional(CONF_TEMP_STEP): vol.All(
            vol.In([PRECISION_TENTHS, PRECISION_HALVES, PRECISION_WHOLE])
        ),
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        **PRESETS_SCHEMA,
    }
)

Definition at line 91 of file climate.py.

VolDictType

homeassistant.components.generic_thermostat.climate.VolDictType

Definition at line 87 of file climate.py.