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

Public Member Functions

None __init__ (self, str name, str|None mode, float target_humidity, float|None current_humidity=None, list[str]|None available_modes=None, bool is_on=True, HumidifierAction|None action=None, HumidifierDeviceClass|None device_class=None)
 
None async_set_humidity (self, int humidity)
 
None async_set_mode (self, str mode)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
HumidifierAction|None action (self)
 
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)
 
str|None mode (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)
 
float|None target_humidity (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
bool|None is_on (self)
 
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 Attributes

 _attr_action
 
 _attr_available_modes
 
 _attr_current_humidity
 
 _attr_device_class
 
 _attr_is_on
 
 _attr_mode
 
 _attr_name
 
 _attr_supported_features
 
 _attr_target_humidity
 

Static Private Attributes

bool _attr_should_poll = False
 

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 demo humidifier device.

Definition at line 54 of file humidifier.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.humidifier.DemoHumidifier.__init__ (   self,
str  name,
str | None  mode,
float  target_humidity,
float | None   current_humidity = None,
list[str] | None   available_modes = None,
bool   is_on = True,
HumidifierAction | None   action = None,
HumidifierDeviceClass | None   device_class = None 
)
Initialize the humidifier device.

Definition at line 59 of file humidifier.py.

Member Function Documentation

◆ async_set_humidity()

None homeassistant.components.demo.humidifier.DemoHumidifier.async_set_humidity (   self,
int  humidity 
)
Set new humidity level.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 93 of file humidifier.py.

◆ async_set_mode()

None homeassistant.components.demo.humidifier.DemoHumidifier.async_set_mode (   self,
str  mode 
)
Update mode.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 98 of file humidifier.py.

◆ async_turn_off()

None homeassistant.components.demo.humidifier.DemoHumidifier.async_turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 88 of file humidifier.py.

◆ async_turn_on()

None homeassistant.components.demo.humidifier.DemoHumidifier.async_turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 83 of file humidifier.py.

Member Data Documentation

◆ _attr_action

homeassistant.components.demo.humidifier.DemoHumidifier._attr_action
private

Definition at line 73 of file humidifier.py.

◆ _attr_available_modes

homeassistant.components.demo.humidifier.DemoHumidifier._attr_available_modes
private

Definition at line 80 of file humidifier.py.

◆ _attr_current_humidity

homeassistant.components.demo.humidifier.DemoHumidifier._attr_current_humidity
private

Definition at line 78 of file humidifier.py.

◆ _attr_device_class

homeassistant.components.demo.humidifier.DemoHumidifier._attr_device_class
private

Definition at line 81 of file humidifier.py.

◆ _attr_is_on

homeassistant.components.demo.humidifier.DemoHumidifier._attr_is_on
private

Definition at line 72 of file humidifier.py.

◆ _attr_mode

homeassistant.components.demo.humidifier.DemoHumidifier._attr_mode
private

Definition at line 79 of file humidifier.py.

◆ _attr_name

homeassistant.components.demo.humidifier.DemoHumidifier._attr_name
private

Definition at line 71 of file humidifier.py.

◆ _attr_should_poll

bool homeassistant.components.demo.humidifier.DemoHumidifier._attr_should_poll = False
staticprivate

Definition at line 57 of file humidifier.py.

◆ _attr_supported_features

homeassistant.components.demo.humidifier.DemoHumidifier._attr_supported_features
private

Definition at line 74 of file humidifier.py.

◆ _attr_target_humidity

homeassistant.components.demo.humidifier.DemoHumidifier._attr_target_humidity
private

Definition at line 77 of file humidifier.py.


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