Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.matter.climate.MatterClimate Class Reference
Inheritance diagram for homeassistant.components.matter.climate.MatterClimate:
[legend]
Collaboration diagram for homeassistant.components.matter.climate.MatterClimate:
[legend]

Public Member Functions

None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_temperature (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.matter.entity.MatterEntity
None __init__ (self, MatterClient matter_client, MatterEndpoint endpoint, MatterEntityInfo entity_info)
 
None async_added_to_hass (self)
 
str get_matter_attribute_path (self, type[ClusterAttributeDescriptor] attribute)
 
Any get_matter_attribute_value (self, type[ClusterAttributeDescriptor] attribute, bool null_as_none=True)
 
str|UndefinedType|None name (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)
 
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, strtranslation_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_fan_mode (self, str fan_mode)
 
None async_set_humidity (self, int humidity)
 
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)
 
float|None current_humidity (self)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
HVACAction|None hvac_action (self)
 
HVACMode|None hvac_mode (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)
 
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)
 
ClimateEntityFeature supported_features (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_humidity (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (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)
 

Static Public Attributes

 HVACMode
 
 None
 
 str
 
- Static Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 None
 
- 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
 

Private Member Functions

None _calculate_features (self)
 
float|None _get_temperature_in_degrees (self, type[clusters.ClusterAttributeDescriptor] attribute)
 
None _update_from_device (self)
 

Private Attributes

 _attr_current_temperature
 
 _attr_hvac_action
 
 _attr_hvac_mode
 
 _attr_max_temp
 
 _attr_min_temp
 
 _attr_supported_features
 
 _attr_target_temperature
 
 _attr_target_temperature_high
 
 _attr_target_temperature_low
 
 _feature_map
 

Static Private Attributes

bool _enable_turn_on_off_backwards_compatibility = False
 
string _platform_translation_key = "thermostat"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 entity_description
 
 matter_client
 
- 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
 

Detailed Description

Representation of a Matter climate entity.

Definition at line 184 of file climate.py.

Member Function Documentation

◆ _calculate_features()

None homeassistant.components.matter.climate.MatterClimate._calculate_features (   self)
private
Calculate features for HA Thermostat platform from Matter FeatureMap.

Definition at line 377 of file climate.py.

◆ _get_temperature_in_degrees()

float | None homeassistant.components.matter.climate.MatterClimate._get_temperature_in_degrees (   self,
type[clusters.ClusterAttributeDescriptor]   attribute 
)
private
Return the scaled temperature value for the given attribute.

Definition at line 416 of file climate.py.

◆ _update_from_device()

None homeassistant.components.matter.climate.MatterClimate._update_from_device (   self)
private
Update from device.

Reimplemented from homeassistant.components.matter.entity.MatterEntity.

Definition at line 270 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.matter.climate.MatterClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 249 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.matter.climate.MatterClimate.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 193 of file climate.py.

Member Data Documentation

◆ _attr_current_temperature

homeassistant.components.matter.climate.MatterClimate._attr_current_temperature
private

Definition at line 273 of file climate.py.

◆ _attr_hvac_action

homeassistant.components.matter.climate.MatterClimate._attr_hvac_action
private

Definition at line 280 of file climate.py.

◆ _attr_hvac_mode

homeassistant.components.matter.climate.MatterClimate._attr_hvac_mode
private

Definition at line 279 of file climate.py.

◆ _attr_max_temp

homeassistant.components.matter.climate.MatterClimate._attr_max_temp
private

Definition at line 372 of file climate.py.

◆ _attr_min_temp

homeassistant.components.matter.climate.MatterClimate._attr_min_temp
private

Definition at line 363 of file climate.py.

◆ _attr_supported_features

homeassistant.components.matter.climate.MatterClimate._attr_supported_features
private

Definition at line 393 of file climate.py.

◆ _attr_target_temperature

homeassistant.components.matter.climate.MatterClimate._attr_target_temperature
private

Definition at line 337 of file climate.py.

◆ _attr_target_temperature_high

homeassistant.components.matter.climate.MatterClimate._attr_target_temperature_high
private

Definition at line 338 of file climate.py.

◆ _attr_target_temperature_low

homeassistant.components.matter.climate.MatterClimate._attr_target_temperature_low
private

Definition at line 341 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.matter.climate.MatterClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 190 of file climate.py.

◆ _feature_map

homeassistant.components.matter.climate.MatterClimate._feature_map
private

Definition at line 387 of file climate.py.

◆ _platform_translation_key

string homeassistant.components.matter.climate.MatterClimate._platform_translation_key = "thermostat"
staticprivate

Definition at line 191 of file climate.py.

◆ HVACMode

homeassistant.components.matter.climate.MatterClimate.HVACMode
static

Definition at line 188 of file climate.py.

◆ None

homeassistant.components.matter.climate.MatterClimate.None
static

Definition at line 189 of file climate.py.

◆ str

homeassistant.components.matter.climate.MatterClimate.str
static

Definition at line 187 of file climate.py.


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