homeassistant.components.homekit_controller.climate.HomeKitClimateEntity Class Reference

Inheritance diagram for homeassistant.components.homekit_controller.climate.HomeKitClimateEntity:

Collaboration diagram for homeassistant.components.homekit_controller.climate.HomeKitClimateEntity:

Public Member Functions
None	async_set_humidity (self, int humidity)
None	async_set_hvac_mode (self, HVACMode hvac_mode)
None	async_set_temperature (self, **Any kwargs)
int	current_humidity (self)
list[str]	get_characteristic_types (self)
HVACAction|None	hvac_action (self)
HVACMode	hvac_mode (self)
list[HVACMode]	hvac_modes (self)
float	max_humidity (self)
float	max_temp (self)
float	min_humidity (self)
float	min_temp (self)
ClimateEntityFeature	supported_features (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.homekit_controller.climate.HomeKitBaseClimateEntity
None	async_set_fan_mode (self, str fan_mode)
float|None	current_temperature (self)
str|None	fan_mode (self)
list[str]|None	fan_modes (self)
Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None	__init__ (self, HKDevice accessory, ConfigType devinfo)
None	async_added_to_hass (self)
None	async_put_characteristics (self, dict[str, Any] characteristics)
None	async_setup (self)
None	async_update (self)
None	async_will_remove_from_hass (self)
bool	available (self)
str|None	default_name (self)
DeviceInfo	device_info (self)
str|None	name (self)
str	old_unique_id (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_write_ha_state (self)
str|None	attribution (self)
str|None	device_class (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)
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_preset_mode (self, str preset_mode)
None	async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
None	async_set_swing_mode (self, str swing_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)
bool|None	is_aux_heat (self)
float	precision (self)
str|None	preset_mode (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)
str|None	swing_horizontal_mode (self)
list[str]|None	swing_horizontal_modes (self)
str|None	swing_mode (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
None	_async_reconfigure (self)

Additional Inherited Members
Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
	accessory
	accessory_info
	all_characteristics
	all_iids
	pollable_characteristics
	service
	watchable_characteristics
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

Representation of a Homekit climate device.

Definition at line 468 of file climate.py.

Member Function Documentation

_async_reconfigure()

None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity._async_reconfigure (   self )

private

Reconfigure entity.

Reimplemented from homeassistant.components.homekit_controller.climate.HomeKitBaseClimateEntity.

Definition at line 472 of file climate.py.

async_set_humidity()

None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.async_set_humidity	(		self,
		int	humidity
	)

Set new target humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 530 of file climate.py.

async_set_hvac_mode()

None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.async_set_hvac_mode	(		self,
		HVACMode	hvac_mode
	)

Set new target operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 536 of file climate.py.

async_set_temperature()

None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.async_set_temperature	(		self,
		**Any	kwargs
	)

Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 491 of file climate.py.

current_humidity()

int homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.current_humidity

(

self

)

Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 627 of file climate.py.

get_characteristic_types()

list[str] homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.get_characteristic_types

(

self

)

Define the homekit characteristics the entity cares about.

Reimplemented from homeassistant.components.homekit_controller.climate.HomeKitBaseClimateEntity.

Definition at line 477 of file climate.py.

hvac_action()

HVACAction | None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.hvac_action

(

self

)

Return the current running hvac operation.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 657 of file climate.py.

hvac_mode()

HVACMode homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.hvac_mode

(

self

)

Return hvac operation ie. heat, cool mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 686 of file climate.py.

hvac_modes()

list[HVACMode] homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.hvac_modes

(

self

)

Return the list of available hvac operation modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 696 of file climate.py.

max_humidity()

float homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.max_humidity

(

self

)

Return the maximum humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 647 of file climate.py.

max_temp()

float homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.max_temp

(

self

)

Return the maximum target temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 605 of file climate.py.

min_humidity()

float homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.min_humidity

(

self

)

Return the minimum humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 637 of file climate.py.

min_temp()

float homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.min_temp

(

self

)

Return the minimum target temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 583 of file climate.py.

supported_features()

ClimateEntityFeature homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.supported_features

(

self

)

Return the list of supported features.

Reimplemented from homeassistant.components.homekit_controller.climate.HomeKitBaseClimateEntity.

Definition at line 705 of file climate.py.

target_humidity()

int homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.target_humidity

(

self

)

Return the humidity we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 632 of file climate.py.

target_temperature()

float | None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.target_temperature

(

self

)

Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 547 of file climate.py.

target_temperature_high()

float | None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.target_temperature_high

(

self

)

Return the highbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 559 of file climate.py.

target_temperature_low()

float | None homeassistant.components.homekit_controller.climate.HomeKitClimateEntity.target_temperature_low

(

self

)

Return the lowbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 571 of file climate.py.

---

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

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