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

Public Member Functions

None __init__ (self, HomematicipHAP hap, AsyncHeatingGroup device)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_temperature (self, **Any kwargs)
 
int current_humidity (self)
 
float current_temperature (self)
 
DeviceInfo device_info (self)
 
dict[str, Any] extra_state_attributes (self)
 
HVACAction|None hvac_action (self)
 
HVACMode hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
float max_temp (self)
 
float min_temp (self)
 
str|None preset_mode (self)
 
list[strpreset_modes (self)
 
float target_temperature (self)
 
- Public Member Functions inherited from homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity
None __init__ (self, HomematicipHAP hap, device, str|None post=None, int|None channel=None, bool|None is_multi_channel=False)
 
None async_added_to_hass (self)
 
None async_remove_from_registries (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
FunctionalChannel get_current_channel (self)
 
str|None icon (self)
 
str name (self)
 
str 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)
 
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)
 
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 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_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)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
float precision (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_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)
 

Private Member Functions

list[str_device_profile_names (self)
 
list[HeatingCoolingProfile] _device_profiles (self)
 
bool _disabled_by_cooling_mode (self)
 
( AsyncHeatingThermostat|AsyncHeatingThermostatCompact|AsyncHeatingThermostatEvo|None_first_radiator_thermostat (self)
 
int _get_profile_idx_by_name (self, str profile_name)
 
str _get_qualified_profile_name (self, HeatingCoolingProfile profile)
 
bool _has_radiator_thermostat (self)
 
bool _has_switch (self)
 
bool _heat_mode_enabled (self)
 
IndoorClimateHome _indoor_climate (self)
 
dict[str, int] _relevant_profile_group (self)
 

Private Attributes

 _simple_heating
 

Static Private Attributes

tuple _attr_supported_features
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity
 functional_channel
 
 hmip_device_removed
 
- 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 the HomematicIP heating group.

Heat mode is supported for all heating devices incl. their defined profiles.
Boost is available for radiator thermostats only.
Cool mode is only available for floor heating systems, if basically enabled in the hmip app.

Definition at line 72 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.__init__ (   self,
HomematicipHAP  hap,
AsyncHeatingGroup  device 
)
Initialize heating group.

Definition at line 86 of file climate.py.

Member Function Documentation

◆ _device_profile_names()

list[str] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._device_profile_names (   self)
private
Return a collection of profile names.

Definition at line 276 of file climate.py.

◆ _device_profiles()

list[HeatingCoolingProfile] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._device_profiles (   self)
private
Return the relevant profiles.

Definition at line 267 of file climate.py.

◆ _disabled_by_cooling_mode()

bool homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._disabled_by_cooling_mode (   self)
private
Return, if group is disabled by the cooling mode.

Definition at line 309 of file climate.py.

◆ _first_radiator_thermostat()

( AsyncHeatingThermostat | AsyncHeatingThermostatCompact | AsyncHeatingThermostatEvo | None ) homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._first_radiator_thermostat (   self)
private
Return the first radiator thermostat from the hmip heating group.

Definition at line 334 of file climate.py.

◆ _get_profile_idx_by_name()

int homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._get_profile_idx_by_name (   self,
str  profile_name 
)
private
Return a profile index by name.

Definition at line 292 of file climate.py.

◆ _get_qualified_profile_name()

str homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._get_qualified_profile_name (   self,
HeatingCoolingProfile  profile 
)
private
Get a name for the given profile. If exists, this is the name of the profile.

Definition at line 283 of file climate.py.

◆ _has_radiator_thermostat()

bool homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._has_radiator_thermostat (   self)
private
Return, if a radiator thermostat is in the hmip heating group.

Definition at line 329 of file climate.py.

◆ _has_switch()

bool homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._has_switch (   self)
private
Return, if a switch is in the hmip heating group.

Definition at line 324 of file climate.py.

◆ _heat_mode_enabled()

bool homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._heat_mode_enabled (   self)
private
Return, if heating mode is enabled.

Definition at line 304 of file climate.py.

◆ _indoor_climate()

IndoorClimateHome homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._indoor_climate (   self)
private
Return the hmip indoor climate functional home of this group.

Definition at line 262 of file climate.py.

◆ _relevant_profile_group()

dict[str, int] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._relevant_profile_group (   self)
private
Return the relevant profile groups.

Definition at line 316 of file climate.py.

◆ async_set_hvac_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 220 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.async_set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 230 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 212 of file climate.py.

◆ current_humidity()

int homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 118 of file climate.py.

◆ current_temperature()

float homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 111 of file climate.py.

◆ device_info()

DeviceInfo homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.device_info (   self)
Return device specific attributes.

Reimplemented from homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.

Definition at line 95 of file climate.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.extra_state_attributes (   self)
Return the state attributes of the access point.

Reimplemented from homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.

Definition at line 245 of file climate.py.

◆ hvac_action()

HVACAction | None homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.hvac_action (   self)
Return the current hvac_action.

This is only relevant for radiator thermostats.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 145 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.hvac_mode (   self)
Return hvac operation ie.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 123 of file climate.py.

◆ hvac_modes()

list[HVACMode] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.hvac_modes (   self)
Return the list of available hvac operation modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 135 of file climate.py.

◆ max_temp()

float homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 208 of file climate.py.

◆ min_temp()

float homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 203 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.preset_mode (   self)
Return the current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 160 of file climate.py.

◆ preset_modes()

list[str] homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.preset_modes (   self)
Return a list of available preset modes incl. hmip profiles.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 184 of file climate.py.

◆ target_temperature()

float homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 106 of file climate.py.

Member Data Documentation

◆ _attr_supported_features

tuple homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.PRESET_MODE | ClimateEntityFeature.TARGET_TEMPERATURE
)

Definition at line 80 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 83 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 84 of file climate.py.

◆ _simple_heating

homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup._simple_heating
private

Definition at line 90 of file climate.py.


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