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

Public Member Functions

None __init__ (self, device)
 
None async_set_fan_mode (self, str fan_mode)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update (self)
 
float|None current_temperature (self)
 
dict[str, Any] extra_state_attributes (self)
 
str fan_mode (self)
 
list[strfan_modes (self)
 
HVACMode|None hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
str swing_mode (self)
 
float target_temperature (self)
 
str temperature_unit (self)
 
- Public Member Functions inherited from homeassistant.components.smartthings.entity.SmartThingsEntity
None __init__ (self, DeviceEntity device)
 
def async_added_to_hass (self)
 
None async_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_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)
 
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)
 
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_humidity (self, int humidity)
 
None async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None async_toggle (self)
 
None async_turn_aux_heat_off (self)
 
None async_turn_aux_heat_on (self)
 
dict[str, Any]|None capability_attributes (self)
 
float|None current_humidity (self)
 
HVACAction|None hvac_action (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)
 
str|None preset_mode (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)
 
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)
 
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]|None _determine_preset_modes (self)
 
ClimateEntityFeature _determine_supported_features (self)
 
list[str]|None _determine_swing_modes (self)
 

Private Attributes

 _attr_preset_mode
 
 _attr_preset_modes
 
 _attr_supported_features
 
 _attr_swing_modes
 
 _hvac_modes
 

Static Private Attributes

bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- 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

Define a SmartThings Air Conditioner.

Definition at line 346 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.__init__ (   self,
  device 
)
Init the class.

Definition at line 352 of file climate.py.

Member Function Documentation

◆ _determine_preset_modes()

list[str] | None homeassistant.components.smartthings.climate.SmartThingsAirConditioner._determine_preset_modes (   self)
private
Return a list of available preset modes.

Definition at line 545 of file climate.py.

◆ _determine_supported_features()

ClimateEntityFeature homeassistant.components.smartthings.climate.SmartThingsAirConditioner._determine_supported_features (   self)
private

Definition at line 361 of file climate.py.

◆ _determine_swing_modes()

list[str] | None homeassistant.components.smartthings.climate.SmartThingsAirConditioner._determine_swing_modes (   self)
private
Return the list of available swing modes.

Definition at line 516 of file climate.py.

◆ async_set_fan_mode()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_set_fan_mode (   self,
str  fan_mode 
)
Set new target fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 374 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 385 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_set_preset_mode (   self,
str  preset_mode 
)
Set special modes (currently only windFree is supported).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 554 of file climate.py.

◆ async_set_swing_mode()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_set_swing_mode (   self,
str  swing_mode 
)
Set swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 528 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 410 of file climate.py.

◆ async_turn_off()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_turn_off (   self)
Turn device off.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 437 of file climate.py.

◆ async_turn_on()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_turn_on (   self)
Turn device on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 430 of file climate.py.

◆ async_update()

None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.async_update (   self)
Update the calculated fields of the AC.

Definition at line 444 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 460 of file climate.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.smartthings.climate.SmartThingsAirConditioner.extra_state_attributes (   self)
Return device specific state attributes.

Include attributes from the Demand Response Load Control (drlc)
and Power Consumption capabilities.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 465 of file climate.py.

◆ fan_mode()

str homeassistant.components.smartthings.climate.SmartThingsAirConditioner.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 485 of file climate.py.

◆ fan_modes()

list[str] homeassistant.components.smartthings.climate.SmartThingsAirConditioner.fan_modes (   self)
Return the list of available fan modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 490 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.smartthings.climate.SmartThingsAirConditioner.hvac_mode (   self)
Return current operation ie. heat, cool, idle.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 495 of file climate.py.

◆ hvac_modes()

list[HVACMode] homeassistant.components.smartthings.climate.SmartThingsAirConditioner.hvac_modes (   self)
Return the list of available operation modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 502 of file climate.py.

◆ swing_mode()

str homeassistant.components.smartthings.climate.SmartThingsAirConditioner.swing_mode (   self)
Return the swing setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 539 of file climate.py.

◆ target_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 507 of file climate.py.

◆ temperature_unit()

str homeassistant.components.smartthings.climate.SmartThingsAirConditioner.temperature_unit (   self)
Return the unit of measurement.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 512 of file climate.py.

Member Data Documentation

◆ _attr_preset_mode

homeassistant.components.smartthings.climate.SmartThingsAirConditioner._attr_preset_mode
private

Definition at line 356 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.smartthings.climate.SmartThingsAirConditioner._attr_preset_modes
private

Definition at line 357 of file climate.py.

◆ _attr_supported_features

homeassistant.components.smartthings.climate.SmartThingsAirConditioner._attr_supported_features
private

Definition at line 359 of file climate.py.

◆ _attr_swing_modes

homeassistant.components.smartthings.climate.SmartThingsAirConditioner._attr_swing_modes
private

Definition at line 358 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.smartthings.climate.SmartThingsAirConditioner._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 350 of file climate.py.

◆ _hvac_modes

homeassistant.components.smartthings.climate.SmartThingsAirConditioner._hvac_modes
private

Definition at line 355 of file climate.py.


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