Inheritance diagram for homeassistant.components.humidifier.HumidifierEntity:

Collaboration diagram for homeassistant.components.humidifier.HumidifierEntity:

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

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)

None	async_turn_off (self, **Any kwargs)

None	async_turn_on (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, str]	translation_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)

Static Public Attributes
	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

Static Private Attributes
	_entity_component_unrecorded_attributes

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Base class for humidifier entities.

Definition at line 156 of file __init__.py.

Member Function Documentation

◆ action()

HumidifierAction | None homeassistant.components.humidifier.HumidifierEntity.action ( self )

Return the current action.

Reimplemented in homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, and homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.

Definition at line 217 of file __init__.py.

◆ async_set_humidity()

None homeassistant.components.humidifier.HumidifierEntity.async_set_humidity	(		self,
		int	humidity
	)

Set new target humidity.

Reimplemented in homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.switchbot.humidifier.SwitchBotHumidifier, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.demo.humidifier.DemoHumidifier, homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, and homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.

Definition at line 251 of file __init__.py.

◆ async_set_mode()

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

Set new mode.

Definition at line 259 of file __init__.py.

◆ available_modes()

list[str] | None homeassistant.components.humidifier.HumidifierEntity.available_modes ( self )

Return a list of available modes.

Requires HumidifierEntityFeature.MODES.

Reimplemented in homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat.

Definition at line 240 of file __init__.py.

◆ capability_attributes()

dict[str, Any] homeassistant.components.humidifier.HumidifierEntity.capability_attributes ( self )

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 175 of file __init__.py.

◆ current_humidity()

float | None homeassistant.components.humidifier.HumidifierEntity.current_humidity ( self )

Return the current humidity.

Reimplemented in homeassistant.components.tuya.humidifier.TuyaHumidifierEntity, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.ecobee.humidifier.EcobeeHumidifier, homeassistant.components.comelit.humidifier.ComelitHumidifierEntity, and homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.

Definition at line 222 of file __init__.py.

◆ device_class()

HumidifierDeviceClass | None homeassistant.components.humidifier.HumidifierEntity.device_class ( self )

Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat.

Definition at line 188 of file __init__.py.

◆ max_humidity()

float homeassistant.components.humidifier.HumidifierEntity.max_humidity ( self )

Return the maximum humidity.

Reimplemented in homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, and homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.

Definition at line 269 of file __init__.py.

◆ min_humidity()

float homeassistant.components.humidifier.HumidifierEntity.min_humidity ( self )

Return the minimum humidity.

Reimplemented in homeassistant.components.zwave_js.humidifier.ZWaveHumidifier, homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, and homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.

Definition at line 264 of file __init__.py.

◆ mode()

str | None homeassistant.components.humidifier.HumidifierEntity.mode ( self )

Return the current mode, e.g., home, auto, baby.

Requires HumidifierEntityFeature.MODES.

Definition at line 232 of file __init__.py.

◆ set_humidity()

None homeassistant.components.humidifier.HumidifierEntity.set_humidity	(		self,
		int	humidity
	)

Set new target humidity.

Reimplemented in homeassistant.components.tuya.humidifier.TuyaHumidifierEntity, and homeassistant.components.ecobee.humidifier.EcobeeHumidifier.

Definition at line 247 of file __init__.py.

◆ set_mode()

None homeassistant.components.humidifier.HumidifierEntity.set_mode	(		self,
		str	mode
	)

Set new mode.

Definition at line 255 of file __init__.py.

◆ state_attributes()

dict[str, Any] homeassistant.components.humidifier.HumidifierEntity.state_attributes ( self )

Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 198 of file __init__.py.

◆ supported_features()

HumidifierEntityFeature homeassistant.components.humidifier.HumidifierEntity.supported_features ( self )

Return the list of supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 274 of file __init__.py.

◆ supported_features_compat()

HumidifierEntityFeature homeassistant.components.humidifier.HumidifierEntity.supported_features_compat ( self )

Return the supported features as HumidifierEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 279 of file __init__.py.

◆ target_humidity()

float | None homeassistant.components.humidifier.HumidifierEntity.target_humidity ( self )

Return the humidity we try to reach.

Definition at line 227 of file __init__.py.

Member Data Documentation

◆ _entity_component_unrecorded_attributes

homeassistant.components.humidifier.HumidifierEntity._entity_component_unrecorded_attributes

staticprivate

Definition at line 159 of file __init__.py.

◆ float

homeassistant.components.humidifier.HumidifierEntity.float

static

Definition at line 168 of file __init__.py.

◆ HumidifierEntityFeature

homeassistant.components.humidifier.HumidifierEntity.HumidifierEntityFeature

static

Definition at line 171 of file __init__.py.

◆ None

homeassistant.components.humidifier.HumidifierEntity.None

static

Definition at line 164 of file __init__.py.

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

core/homeassistant/components/humidifier/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ action()

◆ async_set_humidity()

◆ async_set_mode()

◆ available_modes()

◆ capability_attributes()

◆ current_humidity()

◆ device_class()

◆ max_humidity()

◆ min_humidity()

◆ mode()

◆ set_humidity()

◆ set_mode()

◆ state_attributes()

◆ supported_features()

◆ supported_features_compat()

◆ target_humidity()

Member Data Documentation

◆ _entity_component_unrecorded_attributes

◆ float

◆ HumidifierEntityFeature

◆ None