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

Public Member Functions

None async_set_fan_mode (self, str fan_mode)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_aux_heat_off (self)
 
None async_turn_aux_heat_on (self)
 
int|None current_humidity (self)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
bool is_aux_heat (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
str temperature_unit (self)
 
- Public Member Functions inherited from homeassistant.components.elkm1.entity.ElkEntity
None __init__ (self, Element element, Elk elk, ELKM1Data elk_data)
 
None async_added_to_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
dict[str, Any] extra_state_attributes (self)
 
dict[str, Any] initial_attrs (self)
 
str unique_id (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)
 
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 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_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_off (self)
 
None async_turn_on (self)
 
dict[str, Any]|None capability_attributes (self)
 
list[str]|None fan_modes (self)
 
HVACAction|None hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
list[HVACMode] hvac_modes (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)
 
str|None swing_mode (self)
 
list[str]|None swing_modes (self)
 
float|None target_humidity (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)
 

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 Member Functions

None _element_changed (self, Element element, Any changeset)
 
None _elk_set (self, ThermostatMode|None mode, ThermostatFan|None fan)
 

Private Attributes

 _attr_hvac_mode
 

Static Private Attributes

list _attr_fan_modes = [FAN_AUTO, FAN_ON]
 
 _attr_hvac_modes = SUPPORT_HVAC
 
int _attr_max_temp = 99
 
int _attr_min_temp = 1
 
 _attr_precision = PRECISION_WHOLE
 
tuple _attr_supported_features
 
int _attr_target_temperature_step = 1
 
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
 

Detailed Description

Representation of an Elk-M1 Thermostat.

Definition at line 75 of file climate.py.

Member Function Documentation

◆ _element_changed()

None homeassistant.components.elkm1.climate.ElkThermostat._element_changed (   self,
Element  element,
Any  changeset 
)
private

Definition at line 197 of file climate.py.

◆ _elk_set()

None homeassistant.components.elkm1.climate.ElkThermostat._elk_set (   self,
ThermostatMode | None  mode,
ThermostatFan | None  fan 
)
private

Definition at line 144 of file climate.py.

◆ async_set_fan_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 183 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.elkm1.climate.ElkThermostat.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set thermostat operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 150 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 188 of file climate.py.

◆ async_turn_aux_heat_off()

None homeassistant.components.elkm1.climate.ElkThermostat.async_turn_aux_heat_off (   self)
Turn auxiliary heater off.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 169 of file climate.py.

◆ async_turn_aux_heat_on()

None homeassistant.components.elkm1.climate.ElkThermostat.async_turn_aux_heat_on (   self)
Turn auxiliary heater on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 155 of file climate.py.

◆ current_humidity()

int | None homeassistant.components.elkm1.climate.ElkThermostat.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 128 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.elkm1.climate.ElkThermostat.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 101 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.elkm1.climate.ElkThermostat.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 138 of file climate.py.

◆ is_aux_heat()

bool homeassistant.components.elkm1.climate.ElkThermostat.is_aux_heat (   self)
Return if aux heater is on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 133 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.elkm1.climate.ElkThermostat.target_temperature (   self)
Return the temperature we are trying to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 106 of file climate.py.

◆ target_temperature_high()

float | None homeassistant.components.elkm1.climate.ElkThermostat.target_temperature_high (   self)
Return the high target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 118 of file climate.py.

◆ target_temperature_low()

float | None homeassistant.components.elkm1.climate.ElkThermostat.target_temperature_low (   self)
Return the low target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 123 of file climate.py.

◆ temperature_unit()

str homeassistant.components.elkm1.climate.ElkThermostat.temperature_unit (   self)
Return the temperature unit.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 96 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

list homeassistant.components.elkm1.climate.ElkThermostat._attr_fan_modes = [FAN_AUTO, FAN_ON]
staticprivate

Definition at line 91 of file climate.py.

◆ _attr_hvac_mode

homeassistant.components.elkm1.climate.ElkThermostat._attr_hvac_mode
private

Definition at line 199 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.elkm1.climate.ElkThermostat._attr_hvac_modes = SUPPORT_HVAC
staticprivate

Definition at line 88 of file climate.py.

◆ _attr_max_temp

int homeassistant.components.elkm1.climate.ElkThermostat._attr_max_temp = 99
staticprivate

Definition at line 87 of file climate.py.

◆ _attr_min_temp

int homeassistant.components.elkm1.climate.ElkThermostat._attr_min_temp = 1
staticprivate

Definition at line 86 of file climate.py.

◆ _attr_precision

homeassistant.components.elkm1.climate.ElkThermostat._attr_precision = PRECISION_WHOLE
staticprivate

Definition at line 78 of file climate.py.

◆ _attr_supported_features

tuple homeassistant.components.elkm1.climate.ElkThermostat._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.FAN_MODE
| ClimateEntityFeature.AUX_HEAT
| ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
| ClimateEntityFeature.TURN_OFF
| ClimateEntityFeature.TURN_ON
)

Definition at line 79 of file climate.py.

◆ _attr_target_temperature_step

int homeassistant.components.elkm1.climate.ElkThermostat._attr_target_temperature_step = 1
staticprivate

Definition at line 90 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.elkm1.climate.ElkThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 93 of file climate.py.

◆ None

homeassistant.components.elkm1.climate.ElkThermostat.None
static

Definition at line 89 of file climate.py.


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