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

Public Member Functions

None __init__ (self, DataUpdateCoordinator[Lyric] coordinator, ClimateEntityDescription description, LyricLocation location, LyricDevice device)
 
None async_set_fan_mode (self, str fan_mode)
 
None async_set_hold_time (self, str time_period)
 
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)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
HVACAction|None hvac_action (self)
 
HVACMode hvac_mode (self)
 
float max_temp (self)
 
float min_temp (self)
 
str|None preset_mode (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
- Public Member Functions inherited from homeassistant.components.lyric.entity.LyricDeviceEntity
DeviceInfo device_info (self)
 
- Public Member Functions inherited from homeassistant.components.lyric.entity.LyricEntity
None __init__ (self, DataUpdateCoordinator[Lyric] coordinator, LyricLocation location, LyricDevice device, str key)
 
LyricDevice device (self)
 
LyricLocation location (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)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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_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)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (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_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_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 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_added_to_hass (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)
 
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 Attributes

 entity_description
 
 hvac_mode
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 hvac_mode
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_set_hvac_mode_lcc (self, HVACMode hvac_mode)
 
None _async_set_hvac_mode_tcc (self, HVACMode hvac_mode)
 

Private Attributes

 _attr_fan_modes
 
 _attr_hvac_modes
 
 _attr_precision
 
 _attr_supported_features
 
 _attr_temperature_unit
 
 _attr_thermostat_type
 

Static Private Attributes

 _attr_name = None
 
list _attr_preset_modes
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 bool
 
 ClimateEntityFeature
 
 float
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Defines a Honeywell Lyric climate entity.

Definition at line 163 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lyric.climate.LyricClimate.__init__ (   self,
DataUpdateCoordinator[Lyric]  coordinator,
ClimateEntityDescription  description,
LyricLocation  location,
LyricDevice  device 
)
Initialize Honeywell Lyric climate entity.

Definition at line 179 of file climate.py.

Member Function Documentation

◆ _async_set_hvac_mode_lcc()

None homeassistant.components.lyric.climate.LyricClimate._async_set_hvac_mode_lcc (   self,
HVACMode  hvac_mode 
)
private
Set hvac mode for LCC devices (e.g., T5,6).

Definition at line 447 of file climate.py.

◆ _async_set_hvac_mode_tcc()

None homeassistant.components.lyric.climate.LyricClimate._async_set_hvac_mode_tcc (   self,
HVACMode  hvac_mode 
)
private
Set hvac mode for TCC devices (e.g., Lyric round).

Definition at line 400 of file climate.py.

◆ async_set_fan_mode()

None homeassistant.components.lyric.climate.LyricClimate.async_set_fan_mode (   self,
str  fan_mode 
)
Set fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 492 of file climate.py.

◆ async_set_hold_time()

None homeassistant.components.lyric.climate.LyricClimate.async_set_hold_time (   self,
str  time_period 
)
Set the time to hold until.

Definition at line 478 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.lyric.climate.LyricClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 387 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.lyric.climate.LyricClimate.async_set_preset_mode (   self,
str  preset_mode 
)
Set preset (PermanentHold, HoldUntil, NoHold, VacationHold) mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 467 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 336 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.lyric.climate.LyricClimate.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 253 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.lyric.climate.LyricClimate.fan_mode (   self)
Return current fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 327 of file climate.py.

◆ hvac_action()

HVACAction | None homeassistant.components.lyric.climate.LyricClimate.hvac_action (   self)
Return the current hvac action.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 258 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.lyric.climate.LyricClimate.hvac_mode (   self)
Return the hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 266 of file climate.py.

◆ max_temp()

float homeassistant.components.lyric.climate.LyricClimate.max_temp (   self)
Identify max_temp in Lyric API or defaults if not available.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 319 of file climate.py.

◆ min_temp()

float homeassistant.components.lyric.climate.LyricClimate.min_temp (   self)
Identify min_temp in Lyric API or defaults if not available.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 311 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.lyric.climate.LyricClimate.preset_mode (   self)
Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 306 of file climate.py.

◆ target_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 271 of file climate.py.

◆ target_temperature_high()

float | None homeassistant.components.lyric.climate.LyricClimate.target_temperature_high (   self)
Return the highbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 284 of file climate.py.

◆ target_temperature_low()

float | None homeassistant.components.lyric.climate.LyricClimate.target_temperature_low (   self)
Return the lowbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 295 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

homeassistant.components.lyric.climate.LyricClimate._attr_fan_modes
private

Definition at line 230 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.lyric.climate.LyricClimate._attr_hvac_modes
private

Definition at line 202 of file climate.py.

◆ _attr_name

homeassistant.components.lyric.climate.LyricClimate._attr_name = None
staticprivate

Definition at line 169 of file climate.py.

◆ _attr_precision

homeassistant.components.lyric.climate.LyricClimate._attr_precision
private

Definition at line 196 of file climate.py.

◆ _attr_preset_modes

list homeassistant.components.lyric.climate.LyricClimate._attr_preset_modes
staticprivate
Initial value:
= [
PRESET_NO_HOLD,
PRESET_HOLD_UNTIL,
PRESET_PERMANENT_HOLD,
PRESET_TEMPORARY_HOLD,
PRESET_VACATION_HOLD,
]

Definition at line 170 of file climate.py.

◆ _attr_supported_features

homeassistant.components.lyric.climate.LyricClimate._attr_supported_features
private

Definition at line 222 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.lyric.climate.LyricClimate._attr_temperature_unit
private

Definition at line 195 of file climate.py.

◆ _attr_thermostat_type

homeassistant.components.lyric.climate.LyricClimate._attr_thermostat_type
private

Definition at line 189 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.lyric.climate.LyricClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 177 of file climate.py.

◆ entity_description

homeassistant.components.lyric.climate.LyricClimate.entity_description

Definition at line 250 of file climate.py.

◆ hvac_mode

homeassistant.components.lyric.climate.LyricClimate.hvac_mode

Definition at line 279 of file climate.py.


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