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

Public Member Functions

None __init__ (self, ShellyBlockCoordinator coordinator, Block|None sensor_block, Block|None device_block, RegistryEntry|None entry=None)
 
None async_added_to_hass (self)
 
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)
 
bool available (self)
 
float|None current_temperature (self)
 
ShellyClimateExtraStoredData extra_restore_state_data (self)
 
HVACAction hvac_action (self)
 
HVACMode hvac_mode (self)
 
str|None preset_mode (self)
 
list[strpreset_modes (self)
 
Any set_state_full_path (self, **Any kwargs)
 
float|None target_temperature (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
None __init__ (self, HomeAssistant hass, ShellyConfigEntry entry, BlockDevice device)
 
None async_setup (self, list[Platform]|None pending_platforms=None)
 
CALLBACK_TYPE async_subscribe_input_events (self, Callable[[dict[str, Any]], None] input_event_callback)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (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_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 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)
 
float|None current_humidity (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (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)
 
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)
 

Public Attributes

 block
 
 device_block
 
 last_state
 
 last_state_attributes
 
- Public Attributes inherited from homeassistant.components.shelly.coordinator.ShellyBlockCoordinator
 entry
 
 model
 
- 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
 

Private Member Functions

bool _check_is_off (self)
 
None _handle_coordinator_update (self)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _channel
 
 _last_target_temp
 
 _preset_modes
 
 _unique_id
 

Static Private Attributes

list _attr_hvac_modes = [HVACMode.OFF, HVACMode.HEAT]
 
 _attr_max_temp = SHTRV_01_TEMPERATURE_SETTINGS["max"]
 
 _attr_min_temp = SHTRV_01_TEMPERATURE_SETTINGS["min"]
 
tuple _attr_supported_features
 
 _attr_target_temperature_step = SHTRV_01_TEMPERATURE_SETTINGS["step"]
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- 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 Shelly climate device.

Definition at line 159 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.shelly.climate.BlockSleepingClimate.__init__ (   self,
ShellyBlockCoordinator  coordinator,
Block | None  sensor_block,
Block | None  device_block,
RegistryEntry | None   entry = None 
)
Initialize climate.

Definition at line 177 of file climate.py.

Member Function Documentation

◆ _check_is_off()

bool homeassistant.components.shelly.climate.BlockSleepingClimate._check_is_off (   self)
private
Return if valve is off or on.

Definition at line 301 of file climate.py.

◆ _handle_coordinator_update()

None homeassistant.components.shelly.climate.BlockSleepingClimate._handle_coordinator_update (   self)
private
Handle device update.

Definition at line 391 of file climate.py.

◆ async_added_to_hass()

None homeassistant.components.shelly.climate.BlockSleepingClimate.async_added_to_hass (   self)
Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 372 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.shelly.climate.BlockSleepingClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 345 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.shelly.climate.BlockSleepingClimate.async_set_preset_mode (   self,
str  preset_mode 
)
Set preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 358 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 324 of file climate.py.

◆ available()

bool homeassistant.components.shelly.climate.BlockSleepingClimate.available (   self)
Device availability.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 256 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.shelly.climate.BlockSleepingClimate.current_temperature (   self)
Return current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 240 of file climate.py.

◆ extra_restore_state_data()

ShellyClimateExtraStoredData homeassistant.components.shelly.climate.BlockSleepingClimate.extra_restore_state_data (   self)
Return text specific state data to be restored.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 214 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.shelly.climate.BlockSleepingClimate.hvac_action (   self)
HVAC current action.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 285 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.shelly.climate.BlockSleepingClimate.hvac_mode (   self)
HVAC current mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 263 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.shelly.climate.BlockSleepingClimate.preset_mode (   self)
Preset current mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 276 of file climate.py.

◆ preset_modes()

list[str] homeassistant.components.shelly.climate.BlockSleepingClimate.preset_modes (   self)
Preset available modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 297 of file climate.py.

◆ set_state_full_path()

Any homeassistant.components.shelly.climate.BlockSleepingClimate.set_state_full_path (   self,
**Any  kwargs 
)
Set block state (HTTP request).

Definition at line 308 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.shelly.climate.BlockSleepingClimate.target_temperature (   self)
Set target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 224 of file climate.py.

◆ unique_id()

str homeassistant.components.shelly.climate.BlockSleepingClimate.unique_id (   self)
Set unique id of entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 219 of file climate.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_device_info
private

Definition at line 207 of file climate.py.

◆ _attr_hvac_modes

list homeassistant.components.shelly.climate.BlockSleepingClimate._attr_hvac_modes = [HVACMode.OFF, HVACMode.HEAT]
staticprivate

Definition at line 164 of file climate.py.

◆ _attr_max_temp

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_max_temp = SHTRV_01_TEMPERATURE_SETTINGS["max"]
staticprivate

Definition at line 165 of file climate.py.

◆ _attr_min_temp

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_min_temp = SHTRV_01_TEMPERATURE_SETTINGS["min"]
staticprivate

Definition at line 166 of file climate.py.

◆ _attr_name

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_name
private

Definition at line 194 of file climate.py.

◆ _attr_supported_features

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

Definition at line 167 of file climate.py.

◆ _attr_target_temperature_step

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_target_temperature_step = SHTRV_01_TEMPERATURE_SETTINGS["step"]
staticprivate

Definition at line 173 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.shelly.climate.BlockSleepingClimate._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 174 of file climate.py.

◆ _channel

homeassistant.components.shelly.climate.BlockSleepingClimate._channel
private

Definition at line 211 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.shelly.climate.BlockSleepingClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 175 of file climate.py.

◆ _last_target_temp

homeassistant.components.shelly.climate.BlockSleepingClimate._last_target_temp
private

Definition at line 193 of file climate.py.

◆ _preset_modes

homeassistant.components.shelly.climate.BlockSleepingClimate._preset_modes
private

Definition at line 199 of file climate.py.

◆ _unique_id

homeassistant.components.shelly.climate.BlockSleepingClimate._unique_id
private

Definition at line 197 of file climate.py.

◆ block

homeassistant.components.shelly.climate.BlockSleepingClimate.block

Definition at line 424 of file climate.py.

◆ device_block

homeassistant.components.shelly.climate.BlockSleepingClimate.device_block

Definition at line 422 of file climate.py.

◆ last_state

homeassistant.components.shelly.climate.BlockSleepingClimate.last_state

Definition at line 378 of file climate.py.

◆ last_state_attributes

homeassistant.components.shelly.climate.BlockSleepingClimate.last_state_attributes

Definition at line 379 of file climate.py.


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