homeassistant.components.esphome.climate.EsphomeClimateEntity Class Reference

Inheritance diagram for homeassistant.components.esphome.climate.EsphomeClimateEntity:

Collaboration diagram for homeassistant.components.esphome.climate.EsphomeClimateEntity:

Public Member Functions
None	async_set_fan_mode (self, str fan_mode)
None	async_set_humidity (self, int humidity)
None	async_set_hvac_mode (self, HVACMode hvac_mode)
None	async_set_preset_mode (self, str preset_mode)
None	async_set_swing_mode (self, str swing_mode)
None	async_set_temperature (self, **Any kwargs)
int|None	current_humidity (self)
float|None	current_temperature (self)
str|None	fan_mode (self)
HVACAction|None	hvac_action (self)
HVACMode|None	hvac_mode (self)
str|None	preset_mode (self)
str|None	swing_mode (self)
int	target_humidity (self)
float|None	target_temperature (self)
float|None	target_temperature_high (self)
float|None	target_temperature_low (self)
Public Member Functions inherited from homeassistant.components.esphome.entity.EsphomeEntity
None	__init__ (self, RuntimeEntryData entry_data, str domain, EntityInfo entity_info, type[_StateT] state_type)
None	async_added_to_hass (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Member Functions inherited from homeassistant.components.climate.ClimateEntity
Any	__getattribute__ (self, str name)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	async_handle_set_fan_mode_service (self, str fan_mode)
None	async_handle_set_hvac_mode_service (self, HVACMode hvac_mode)
None	async_handle_set_preset_mode_service (self, str preset_mode)
None	async_handle_set_swing_horizontal_mode_service (self, str swing_horizontal_mode)
None	async_handle_set_swing_mode_service (self, str swing_mode)
None	async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
None	async_toggle (self)
None	async_turn_aux_heat_off (self)
None	async_turn_aux_heat_on (self)
None	async_turn_off (self)
None	async_turn_on (self)
dict[str, Any]|None	capability_attributes (self)
list[str]|None	fan_modes (self)
list[HVACMode]	hvac_modes (self)
bool|None	is_aux_heat (self)
float	max_humidity (self)
float	max_temp (self)
float	min_humidity (self)
float	min_temp (self)
float	precision (self)
list[str]|None	preset_modes (self)
None	set_fan_mode (self, str fan_mode)
None	set_humidity (self, int humidity)
None	set_hvac_mode (self, HVACMode hvac_mode)
None	set_preset_mode (self, str preset_mode)
None	set_swing_horizontal_mode (self, str swing_horizontal_mode)
None	set_swing_mode (self, str swing_mode)
None	set_temperature (self, **Any kwargs)
str|None	state (self)
dict[str, Any]	state_attributes (self)
ClimateEntityFeature	supported_features (self)
str|None	swing_horizontal_mode (self)
list[str]|None	swing_horizontal_modes (self)
list[str]|None	swing_modes (self)
float|None	target_temperature_step (self)
str	temperature_unit (self)
None	toggle (self)
None	turn_aux_heat_off (self)
None	turn_aux_heat_on (self)
None	turn_off (self)
None	turn_on (self)

Private Member Functions
float	_get_precision (self)
None	_on_static_info_update (self, EntityInfo static_info)

Private Attributes
	_attr_fan_modes
	_attr_hvac_modes
	_attr_max_humidity
	_attr_max_temp
	_attr_min_humidity
	_attr_min_temp
	_attr_precision
	_attr_preset_modes
	_attr_supported_features
	_attr_swing_modes
	_attr_target_temperature_step

Static Private Attributes
	_attr_temperature_unit = UnitOfTemperature.CELSIUS
string	_attr_translation_key = "climate"
bool	_enable_turn_on_off_backwards_compatibility = False

Additional Inherited Members
Public Attributes inherited from homeassistant.components.esphome.entity.EsphomeEntity
	entity_id
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.climate.ClimateEntity
	hvac_mode
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
	bool
	ClimateEntityFeature
	float
	None

Detailed Description

A climate implementation for ESPHome.

Definition at line 127 of file climate.py.

Member Function Documentation

_get_precision()

float homeassistant.components.esphome.climate.EsphomeClimateEntity._get_precision (   self )

private

Return the precision of the climate device.

Definition at line 179 of file climate.py.

_on_static_info_update()

None homeassistant.components.esphome.climate.EsphomeClimateEntity._on_static_info_update (   self, EntityInfo  static_info  )

private

Set attrs from static info.

Reimplemented from homeassistant.components.esphome.entity.EsphomeEntity.

Definition at line 135 of file climate.py.

async_set_fan_mode()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_fan_mode	(		self,
		str	fan_mode
	)

Set new fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 307 of file climate.py.

async_set_humidity()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_humidity	(		self,
		int	humidity
	)

Set new target humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 285 of file climate.py.

async_set_hvac_mode()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_hvac_mode	(		self,
		HVACMode	hvac_mode
	)

Set new target operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 290 of file climate.py.

async_set_preset_mode()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_preset_mode	(		self,
		str	preset_mode
	)

Set preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 297 of file climate.py.

async_set_swing_mode()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_swing_mode	(		self,
		str	swing_mode
	)

Set new swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 317 of file climate.py.

async_set_temperature()

None homeassistant.components.esphome.climate.EsphomeClimateEntity.async_set_temperature	(		self,
		**Any	kwargs
	)

Set new target temperature (and operation mode if set).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 269 of file climate.py.

current_humidity()

int | None homeassistant.components.esphome.climate.EsphomeClimateEntity.current_humidity

(

self

)

Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 238 of file climate.py.

current_temperature()

float | None homeassistant.components.esphome.climate.EsphomeClimateEntity.current_temperature

(

self

)

Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 232 of file climate.py.

fan_mode()

str | None homeassistant.components.esphome.climate.EsphomeClimateEntity.fan_mode

(

self

)

Return current fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 210 of file climate.py.

hvac_action()

HVACAction | None homeassistant.components.esphome.climate.EsphomeClimateEntity.hvac_action

(

self

)

Return current action.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 201 of file climate.py.

hvac_mode()

HVACMode | None homeassistant.components.esphome.climate.EsphomeClimateEntity.hvac_mode

(

self

)

Return current operation ie. heat, cool, idle.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 195 of file climate.py.

preset_mode()

str | None homeassistant.components.esphome.climate.EsphomeClimateEntity.preset_mode

(

self

)

Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 217 of file climate.py.

swing_mode()

str | None homeassistant.components.esphome.climate.EsphomeClimateEntity.swing_mode

(

self

)

Return current swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 226 of file climate.py.

target_humidity()

int homeassistant.components.esphome.climate.EsphomeClimateEntity.target_humidity

(

self

)

Return the humidity we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 264 of file climate.py.

target_temperature()

float | None homeassistant.components.esphome.climate.EsphomeClimateEntity.target_temperature

(

self

)

Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 246 of file climate.py.

target_temperature_high()

float | None homeassistant.components.esphome.climate.EsphomeClimateEntity.target_temperature_high

(

self

)

Return the highbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 258 of file climate.py.

target_temperature_low()

float | None homeassistant.components.esphome.climate.EsphomeClimateEntity.target_temperature_low

(

self

)

Return the lowbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 252 of file climate.py.

Member Data Documentation

_attr_fan_modes

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_fan_modes

private

Definition at line 143 of file climate.py.

_attr_hvac_modes

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_hvac_modes

private

Definition at line 140 of file climate.py.

_attr_max_humidity

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_max_humidity

private

Definition at line 161 of file climate.py.

_attr_max_temp

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_max_temp

private

Definition at line 159 of file climate.py.

_attr_min_humidity

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_min_humidity

private

Definition at line 160 of file climate.py.

_attr_min_temp

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_min_temp

private

Definition at line 158 of file climate.py.

_attr_precision

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_precision

private

Definition at line 139 of file climate.py.

_attr_preset_modes

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_preset_modes

private

Definition at line 146 of file climate.py.

_attr_supported_features

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_supported_features

private

Definition at line 177 of file climate.py.

_attr_swing_modes

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_swing_modes

private

Definition at line 150 of file climate.py.

_attr_target_temperature_step

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_target_temperature_step

private

Definition at line 155 of file climate.py.

_attr_temperature_unit

homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_temperature_unit = UnitOfTemperature.CELSIUS

staticprivate

Definition at line 130 of file climate.py.

_attr_translation_key

string homeassistant.components.esphome.climate.EsphomeClimateEntity._attr_translation_key = "climate"

staticprivate

Definition at line 131 of file climate.py.

_enable_turn_on_off_backwards_compatibility

bool homeassistant.components.esphome.climate.EsphomeClimateEntity._enable_turn_on_off_backwards_compatibility = False

staticprivate

Definition at line 132 of file climate.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/esphome/climate.py