homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity Class Reference

Inheritance diagram for homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity:

Collaboration diagram for homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity:

Public Member Functions
None	__init__ (self, AprilaireCoordinator coordinator, AprilaireHumidifierDescription description, str unique_id)
HumidifierAction|None	action (self)
None	async_set_humidity (self, int humidity)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
float|None	current_humidity (self)
bool	is_on (self)
float	max_humidity (self)
float	min_humidity (self)
float|None	target_humidity (self)
Public Member Functions inherited from homeassistant.components.aprilaire.entity.BaseAprilaireEntity
None	__init__ (self, AprilaireCoordinator coordinator, str|None unique_id)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
None	__init__ (self, HomeAssistant hass, str|None unique_id, str host, int port)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_set_updated_data (self, Any data)
None	async_update_listeners (self)
DeviceInfo|None	create_device_info (self, dict[str, Any] data)
str	create_device_name (self, dict[str, Any]|None data)
DeviceInfo|None	device_info (self)
str	device_name (self)
str	get_hw_version (self, dict[str, Any] data)
def	start_listen (self)
def	stop_listen (self)
bool	wait_for_ready (self, Callable[[bool], Awaitable[None]] ready_callback)
Public Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
None	async_set_mode (self, str mode)
list[str]|None	available_modes (self)
dict[str, Any]	capability_attributes (self)
HumidifierDeviceClass|None	device_class (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)
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, 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)

Public Attributes
	entity_description
	last_target_humidity
Public Attributes inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
	client
	data
	hass
	unique_id
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

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

Base humidity entity for Aprilaire.

Definition at line 107 of file humidifier.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.__init__	(		self,
		AprilaireCoordinator	coordinator,
		AprilaireHumidifierDescription	description,
		str	unique_id
	)

Initialize a select for an Aprilaire device.

Definition at line 113 of file humidifier.py.

Member Function Documentation

action()

HumidifierAction | None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.action

(

self

)

Get the current action.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 126 of file humidifier.py.

async_set_humidity()

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

Set the humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 174 of file humidifier.py.

async_turn_off()

None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 189 of file humidifier.py.

async_turn_on()

None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 179 of file humidifier.py.

current_humidity()

float | None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.current_humidity

(

self

)

Get the current humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 140 of file humidifier.py.

is_on()

bool homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.is_on

(

self

)

Get whether the humidifier is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 134 of file humidifier.py.

max_humidity()

float homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.max_humidity

(

self

)

Return the maximum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 169 of file humidifier.py.

min_humidity()

float homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.min_humidity

(

self

)

Return the minimum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 163 of file humidifier.py.

target_humidity()

float | None homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.target_humidity

(

self

)

Get the target humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 149 of file humidifier.py.

Member Data Documentation

entity_description

homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.entity_description

Definition at line 121 of file humidifier.py.

last_target_humidity

homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.last_target_humidity

Definition at line 158 of file humidifier.py.

None

homeassistant.components.aprilaire.humidifier.AprilaireHumidifierEntity.None

static

Definition at line 111 of file humidifier.py.

---

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

• core/homeassistant/components/aprilaire/humidifier.py