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

Public Member Functions

def __init__ (self, device, entry, unique_id, coordinator)
 
None async_set_humidity (self, float humidity)
 
None async_set_mode (self, str mode)
 
def is_on (self)
 
def mode (self)
 
def target_humidity (self)
 
- Public Member Functions inherited from homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
float|None translate_humidity (self, float humidity)
 
- Public Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
HumidifierAction|None action (self)
 
None async_set_humidity (self, int humidity)
 
list[str]|None available_modes (self)
 
dict[str, Any] capability_attributes (self)
 
float|None current_humidity (self)
 
HumidifierDeviceClass|None device_class (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
None set_humidity (self, int humidity)
 
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)
 
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 available (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)
 

Private Member Functions

def _handle_coordinator_update (self)
 

Private Attributes

 _attr_available_modes
 
 _attr_current_humidity
 
 _attr_max_humidity
 
 _attr_min_humidity
 
 _humidity_steps
 
 _mode
 
 _state
 
 _target_humidity
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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

Representation of a Xiaomi Air Humidifier.

Definition at line 173 of file humidifier.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.__init__ (   self,
  device,
  entry,
  unique_id,
  coordinator 
)
Initialize the plug switch.

Reimplemented from homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier.

Definition at line 178 of file humidifier.py.

Member Function Documentation

◆ _handle_coordinator_update()

def homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._handle_coordinator_update (   self)
private
Fetch state from the device.

Definition at line 214 of file humidifier.py.

◆ async_set_humidity()

None homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.async_set_humidity (   self,
float  humidity 
)
Set the target humidity of the humidifier and set the mode to auto.

Reimplemented in homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifierMjjsq, and homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifierMiot.

Definition at line 243 of file humidifier.py.

◆ async_set_mode()

None homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.async_set_mode (   self,
str  mode 
)

◆ is_on()

def homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.components.xiaomi_miio.humidifier.XiaomiGenericHumidifier.

Definition at line 209 of file humidifier.py.

◆ mode()

def homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.mode (   self)

◆ target_humidity()

def homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier.target_humidity (   self)

Member Data Documentation

◆ _attr_available_modes

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._attr_available_modes
private

Definition at line 185 of file humidifier.py.

◆ _attr_current_humidity

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._attr_current_humidity
private

Definition at line 205 of file humidifier.py.

◆ _attr_max_humidity

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._attr_max_humidity
private

Definition at line 183 of file humidifier.py.

◆ _attr_min_humidity

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._attr_min_humidity
private

Definition at line 182 of file humidifier.py.

◆ _humidity_steps

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._humidity_steps
private

Definition at line 186 of file humidifier.py.

◆ _mode

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._mode
private

Definition at line 206 of file humidifier.py.

◆ _state

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._state
private

Definition at line 197 of file humidifier.py.

◆ _target_humidity

homeassistant.components.xiaomi_miio.humidifier.XiaomiAirHumidifier._target_humidity
private

Definition at line 204 of file humidifier.py.


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