Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecobee.humidifier.EcobeeHumidifier Class Reference
Inheritance diagram for homeassistant.components.ecobee.humidifier.EcobeeHumidifier:
[legend]
Collaboration diagram for homeassistant.components.ecobee.humidifier.EcobeeHumidifier:
[legend]

Public Member Functions

def __init__ (self, data, thermostat_index)
 
def async_update (self)
 
def available (self)
 
int|None current_humidity (self)
 
DeviceInfo device_info (self)
 
def is_on (self)
 
def mode (self)
 
None set_humidity (self, int humidity)
 
def set_mode (self, mode)
 
int target_humidity (self)
 
def turn_off (self, **kwargs)
 
def turn_on (self, **kwargs)
 
- Public Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
HumidifierAction|None action (self)
 
None async_set_humidity (self, int humidity)
 
None async_set_mode (self, str mode)
 
list[str]|None available_modes (self)
 
dict[str, Any] capability_attributes (self)
 
HumidifierDeviceClass|None device_class (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
None set_mode (self, str mode)
 
dict[str, Any] state_attributes (self)
 
HumidifierEntityFeature supported_features (self)
 
HumidifierEntityFeature supported_features_compat (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- 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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
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 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

 data
 
 thermostat
 
 thermostat_index
 
 update_without_throttle
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_unique_id
 
 _last_humidifier_on_mode
 

Static Private Attributes

list _attr_available_modes = [MODE_OFF, MODE_AUTO, MODE_MANUAL]
 
 _attr_device_class = HumidifierDeviceClass.HUMIDIFIER
 
bool _attr_has_entity_name = True
 
 _attr_max_humidity = DEFAULT_MAX_HUMIDITY
 
 _attr_min_humidity = DEFAULT_MIN_HUMIDITY
 
 _attr_name = None
 
 _attr_supported_features = HumidifierEntityFeature.MODES
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.humidifier.HumidifierEntity
 float
 
 HumidifierEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

A humidifier class for an ecobee thermostat with humidifier attached.

Definition at line 44 of file humidifier.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.__init__ (   self,
  data,
  thermostat_index 
)
Initialize ecobee humidifier platform.

Definition at line 55 of file humidifier.py.

Member Function Documentation

◆ async_update()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.async_update (   self)
Get the latest state from the thermostat.

Definition at line 87 of file humidifier.py.

◆ available()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.available (   self)
Return if device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 83 of file humidifier.py.

◆ current_humidity()

int | None homeassistant.components.ecobee.humidifier.EcobeeHumidifier.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 114 of file humidifier.py.

◆ device_info()

DeviceInfo homeassistant.components.ecobee.humidifier.EcobeeHumidifier.device_info (   self)
Return device information for the ecobee humidifier.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 66 of file humidifier.py.

◆ is_on()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.is_on (   self)
Return True if the humidifier is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 99 of file humidifier.py.

◆ mode()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.mode (   self)
Return the current mode, e.g., off, auto, manual.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 104 of file humidifier.py.

◆ set_humidity()

None homeassistant.components.ecobee.humidifier.EcobeeHumidifier.set_humidity (   self,
int  humidity 
)
Set the humidity level.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 132 of file humidifier.py.

◆ set_mode()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.set_mode (   self,
  mode 
)
Set humidifier mode (auto, off, manual).

Definition at line 121 of file humidifier.py.

◆ target_humidity()

int homeassistant.components.ecobee.humidifier.EcobeeHumidifier.target_humidity (   self)
Return the desired humidity set point.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 109 of file humidifier.py.

◆ turn_off()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.turn_off (   self,
**  kwargs 
)
Set humidifier to off mode.

Definition at line 137 of file humidifier.py.

◆ turn_on()

def homeassistant.components.ecobee.humidifier.EcobeeHumidifier.turn_on (   self,
**  kwargs 
)
Set humidifier to on mode.

Definition at line 141 of file humidifier.py.

Member Data Documentation

◆ _attr_available_modes

list homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_available_modes = [MODE_OFF, MODE_AUTO, MODE_MANUAL]
staticprivate

Definition at line 48 of file humidifier.py.

◆ _attr_device_class

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_device_class = HumidifierDeviceClass.HUMIDIFIER
staticprivate

Definition at line 49 of file humidifier.py.

◆ _attr_has_entity_name

bool homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_has_entity_name = True
staticprivate

Definition at line 52 of file humidifier.py.

◆ _attr_max_humidity

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_max_humidity = DEFAULT_MAX_HUMIDITY
staticprivate

Definition at line 51 of file humidifier.py.

◆ _attr_min_humidity

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_min_humidity = DEFAULT_MIN_HUMIDITY
staticprivate

Definition at line 50 of file humidifier.py.

◆ _attr_name

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_name = None
staticprivate

Definition at line 53 of file humidifier.py.

◆ _attr_supported_features

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_supported_features = HumidifierEntityFeature.MODES
staticprivate

Definition at line 47 of file humidifier.py.

◆ _attr_unique_id

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._attr_unique_id
private

Definition at line 60 of file humidifier.py.

◆ _last_humidifier_on_mode

homeassistant.components.ecobee.humidifier.EcobeeHumidifier._last_humidifier_on_mode
private

Definition at line 61 of file humidifier.py.

◆ data

homeassistant.components.ecobee.humidifier.EcobeeHumidifier.data

Definition at line 57 of file humidifier.py.

◆ thermostat

homeassistant.components.ecobee.humidifier.EcobeeHumidifier.thermostat

Definition at line 59 of file humidifier.py.

◆ thermostat_index

homeassistant.components.ecobee.humidifier.EcobeeHumidifier.thermostat_index

Definition at line 58 of file humidifier.py.

◆ update_without_throttle

homeassistant.components.ecobee.humidifier.EcobeeHumidifier.update_without_throttle

Definition at line 63 of file humidifier.py.


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