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

Public Member Functions

None __init__ (self, OpenThermGatewayHub gw_hub, OpenThermClimateEntityDescription description, MappingProxyType[str, Any] options)
 
None async_added_to_hass (self)
 
None async_set_temperature (self, **Any kwargs)
 
str preset_mode (self)
 
def receive_report (self, dict[OpenThermDataSource, dict] status)
 
None set_preset_mode (self, str preset_mode)
 
float|None target_temperature (self)
 
def update_options (self, entry)
 
- Public Member Functions inherited from homeassistant.components.opentherm_gw.entity.OpenThermEntity
None __init__ (self, OpenThermGatewayHub gw_hub, OpenThermEntityDescription description)
 
bool available (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)
 
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, 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_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_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)
 
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_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)
 

Public Attributes

 temporary_ovrd_mode
 
- Public Attributes inherited from homeassistant.components.opentherm_gw.entity.OpenThermEntity
 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

 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 Attributes

 _attr_current_temperature
 
 _attr_hvac_action
 
 _attr_precision
 
 _attr_target_temperature_step
 
 _away_mode_a
 
 _away_mode_b
 
 _away_state_a
 
 _away_state_b
 
 _new_target_temperature
 
 _target_temperature
 

Static Private Attributes

 _attr_hvac_mode = HVACMode.HEAT
 
list _attr_hvac_modes = []
 
int _attr_max_temp = 30
 
int _attr_min_temp = 1
 
 _attr_name = None
 
list _attr_preset_modes = []
 
tuple _attr_supported_features
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
bool _away_state_a = False
 
bool _away_state_b = False
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Detailed Description

Representation of a climate device.

Definition at line 72 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.opentherm_gw.climate.OpenThermClimate.__init__ (   self,
OpenThermGatewayHub  gw_hub,
OpenThermClimateEntityDescription  description,
MappingProxyType[str, Any]  options 
)
Initialize the entity.

Definition at line 94 of file climate.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.opentherm_gw.climate.OpenThermClimate.async_added_to_hass (   self)
Connect to the OpenTherm Gateway device.

Reimplemented from homeassistant.components.opentherm_gw.entity.OpenThermStatusEntity.

Definition at line 115 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 192 of file climate.py.

◆ preset_mode()

str homeassistant.components.opentherm_gw.climate.OpenThermClimate.preset_mode (   self)
Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 182 of file climate.py.

◆ receive_report()

def homeassistant.components.opentherm_gw.climate.OpenThermClimate.receive_report (   self,
dict[OpenThermDataSource, dict]  status 
)
Receive and handle a new report from the Gateway.

Reimplemented from homeassistant.components.opentherm_gw.entity.OpenThermStatusEntity.

Definition at line 125 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.opentherm_gw.climate.OpenThermClimate.set_preset_mode (   self,
str  preset_mode 
)
Set the preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 188 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.opentherm_gw.climate.OpenThermClimate.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 177 of file climate.py.

◆ update_options()

def homeassistant.components.opentherm_gw.climate.OpenThermClimate.update_options (   self,
  entry 
)
Update climate entity options.

Definition at line 108 of file climate.py.

Member Data Documentation

◆ _attr_current_temperature

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_current_temperature
private

Definition at line 141 of file climate.py.

◆ _attr_hvac_action

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_hvac_action
private

Definition at line 133 of file climate.py.

◆ _attr_hvac_mode

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_hvac_mode = HVACMode.HEAT
staticprivate

Definition at line 84 of file climate.py.

◆ _attr_hvac_modes

list homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_hvac_modes = []
staticprivate

Definition at line 79 of file climate.py.

◆ _attr_max_temp

int homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_max_temp = 30
staticprivate

Definition at line 83 of file climate.py.

◆ _attr_min_temp

int homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_min_temp = 1
staticprivate

Definition at line 82 of file climate.py.

◆ _attr_name

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_name = None
staticprivate

Definition at line 80 of file climate.py.

◆ _attr_precision

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_precision
private

Definition at line 103 of file climate.py.

◆ _attr_preset_modes

list homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_preset_modes = []
staticprivate

Definition at line 81 of file climate.py.

◆ _attr_supported_features

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

Definition at line 75 of file climate.py.

◆ _attr_target_temperature_step

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_target_temperature_step
private

Definition at line 104 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.opentherm_gw.climate.OpenThermClimate._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 78 of file climate.py.

◆ _away_mode_a

homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_mode_a
private

Definition at line 156 of file climate.py.

◆ _away_mode_b

homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_mode_b
private

Definition at line 157 of file climate.py.

◆ _away_state_a [1/2]

bool homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_state_a = False
staticprivate

Definition at line 87 of file climate.py.

◆ _away_state_a [2/2]

homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_state_a
private

Definition at line 158 of file climate.py.

◆ _away_state_b [1/2]

bool homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_state_b = False
staticprivate

Definition at line 88 of file climate.py.

◆ _away_state_b [2/2]

homeassistant.components.opentherm_gw.climate.OpenThermClimate._away_state_b
private

Definition at line 166 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.opentherm_gw.climate.OpenThermClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 89 of file climate.py.

◆ _new_target_temperature

homeassistant.components.opentherm_gw.climate.OpenThermClimate._new_target_temperature
private

Definition at line 149 of file climate.py.

◆ _target_temperature

homeassistant.components.opentherm_gw.climate.OpenThermClimate._target_temperature
private

Definition at line 150 of file climate.py.

◆ None

homeassistant.components.opentherm_gw.climate.OpenThermClimate.None
static

Definition at line 85 of file climate.py.

◆ temporary_ovrd_mode

homeassistant.components.opentherm_gw.climate.OpenThermClimate.temporary_ovrd_mode

Definition at line 105 of file climate.py.


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