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

Public Member Functions

def current_humidity (self)
 
def current_temperature (self)
 
HVACMode hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
def max_temp (self)
 
def min_temp (self)
 
def preset_mode (self)
 
def preset_modes (self)
 
None set_hvac_mode (self, HVACMode hvac_mode)
 
None set_preset_mode (self, str preset_mode)
 
None set_temperature (self, **Any kwargs)
 
def target_temperature (self)
 
def target_temperature_step (self)
 
- Public Member Functions inherited from homeassistant.components.homematic.entity.HMDevice
None __init__ (self, dict[str, str] config, EntityDescription|None entity_description=None)
 
def async_added_to_hass (self)
 
def available (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def unique_id (self)
 
def update (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)
 
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)
 
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 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_hvac_mode (self, HVACMode hvac_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_set_temperature (self, **Any kwargs)
 
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)
 
HVACAction|None hvac_action (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_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None set_swing_mode (self, str swing_mode)
 
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)
 
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

def _hm_control_mode (self)
 
def _init_data_struct (self)
 

Private Attributes

 _hm_control_mode
 
 _state
 

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.homematic.entity.HMDevice
 entity_description
 
- 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 Homematic thermostat.

Definition at line 56 of file climate.py.

Member Function Documentation

◆ _hm_control_mode()

def homeassistant.components.homematic.climate.HMThermostat._hm_control_mode (   self)
private
Return Control mode.

Definition at line 184 of file climate.py.

◆ _init_data_struct()

def homeassistant.components.homematic.climate.HMThermostat._init_data_struct (   self)
private
Generate a data dict (self._data) from the Homematic metadata.

Reimplemented from homeassistant.components.homematic.entity.HMDevice.

Definition at line 192 of file climate.py.

◆ current_humidity()

def homeassistant.components.homematic.climate.HMThermostat.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 123 of file climate.py.

◆ current_temperature()

def homeassistant.components.homematic.climate.HMThermostat.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 131 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.homematic.climate.HMThermostat.hvac_mode (   self)
Return hvac operation ie. heat, cool mode.

Need to be one of HVAC_MODE_*.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 69 of file climate.py.

◆ hvac_modes()

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

Need to be a subset of HVAC_MODES.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 87 of file climate.py.

◆ max_temp()

def homeassistant.components.homematic.climate.HMThermostat.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 174 of file climate.py.

◆ min_temp()

def homeassistant.components.homematic.climate.HMThermostat.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 169 of file climate.py.

◆ preset_mode()

def homeassistant.components.homematic.climate.HMThermostat.preset_mode (   self)
Return the current preset mode, e.g., home, away, temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 97 of file climate.py.

◆ preset_modes()

def homeassistant.components.homematic.climate.HMThermostat.preset_modes (   self)
Return a list of available preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 114 of file climate.py.

◆ set_hvac_mode()

None homeassistant.components.homematic.climate.HMThermostat.set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 150 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.homematic.climate.HMThermostat.set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 159 of file climate.py.

◆ set_temperature()

None homeassistant.components.homematic.climate.HMThermostat.set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 143 of file climate.py.

◆ target_temperature()

def homeassistant.components.homematic.climate.HMThermostat.target_temperature (   self)
Return the target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 139 of file climate.py.

◆ target_temperature_step()

def homeassistant.components.homematic.climate.HMThermostat.target_temperature_step (   self)
Return the supported step of target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 179 of file climate.py.

Member Data Documentation

◆ _attr_supported_features

tuple homeassistant.components.homematic.climate.HMThermostat._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.TARGET_TEMPERATURE
| ClimateEntityFeature.PRESET_MODE
| ClimateEntityFeature.TURN_OFF
| ClimateEntityFeature.TURN_ON
)

Definition at line 59 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.homematic.climate.HMThermostat._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 65 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.homematic.climate.HMThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 66 of file climate.py.

◆ _hm_control_mode

homeassistant.components.homematic.climate.HMThermostat._hm_control_mode
private

Definition at line 77 of file climate.py.

◆ _state

homeassistant.components.homematic.climate.HMThermostat._state
private

Definition at line 194 of file climate.py.


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