Inheritance diagram for homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier:

Collaboration diagram for homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier:

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

int\|None	current_humidity (self)

list[str]	get_characteristic_types (self)

bool	is_on (self)

int	max_humidity (self)

int	min_humidity (self)

str\|None	mode (self)

int\|None	target_humidity (self)

Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None	__init__ (self, HKDevice accessory, ConfigType devinfo)

None	async_added_to_hass (self)

None	async_put_characteristics (self, dict[str, Any] characteristics)

None	async_setup (self)

None	async_update (self)

None	async_will_remove_from_hass (self)

bool	available (self)

str\|None	default_name (self)

DeviceInfo	device_info (self)

str\|None	name (self)

str	old_unique_id (self)

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_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_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)

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 Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
HumidifierAction\|None	action (self)

list[str]\|None	available_modes (self)

dict[str, Any]	capability_attributes (self)

HumidifierDeviceClass\|None	device_class (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)

Private Member Functions
None	_async_reconfigure (self)

Static Private Attributes
list	_attr_available_modes = [MODE_NORMAL, MODE_AUTO]

	_attr_supported_features = HumidifierEntityFeature.MODES

	_humidity_char = CharacteristicsTypes.RELATIVE_HUMIDITY_HUMIDIFIER_THRESHOLD

int	_on_mode_value = 1

Additional Inherited Members
Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
	accessory

	accessory_info

	all_characteristics

	all_iids

	pollable_characteristics

	service

	watchable_characteristics

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Static Public Attributes inherited from homeassistant.components.humidifier.HumidifierEntity
	float

	HumidifierEntityFeature

	None

Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
	None

Detailed Description

Representation of a HomeKit Controller Humidifier.

Definition at line 44 of file humidifier.py.

Member Function Documentation

◆ _async_reconfigure()

None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier._async_reconfigure ( self )

private

Reconfigure entity.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 53 of file humidifier.py.

◆ async_set_humidity()

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

Set new target humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 94 of file humidifier.py.

◆ async_set_mode()

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

Set new mode.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 106 of file humidifier.py.

◆ async_turn_off()

None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the specified valve off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 102 of file humidifier.py.

◆ async_turn_on()

None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the specified valve on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 98 of file humidifier.py.

◆ current_humidity()

int | None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.current_humidity ( self )

Return the current humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 75 of file humidifier.py.

◆ get_characteristic_types()

list[str] homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.get_characteristic_types ( self )

Define the homekit characteristics the entity cares about.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Reimplemented in homeassistant.components.homekit_controller.humidifier.HomeKitDehumidifier.

Definition at line 123 of file humidifier.py.

◆ is_on()

bool homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.is_on ( self )

Return true if device is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 59 of file humidifier.py.

◆ max_humidity()

int homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.max_humidity ( self )

Return the maximum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 90 of file humidifier.py.

◆ min_humidity()

int homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.min_humidity ( self )

Return the minimum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 85 of file humidifier.py.

◆ mode()

str | None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.mode ( self )

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

Requires HumidifierEntityFeature.MODES.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 64 of file humidifier.py.

◆ target_humidity()

int | None homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier.target_humidity ( self )

Return the humidity we try to reach.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 80 of file humidifier.py.

Member Data Documentation

◆ _attr_available_modes

list homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier._attr_available_modes = [MODE_NORMAL, MODE_AUTO]

staticprivate

Definition at line 48 of file humidifier.py.

◆ _attr_supported_features

homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier._attr_supported_features = HumidifierEntityFeature.MODES

staticprivate

Definition at line 47 of file humidifier.py.

◆ _humidity_char

homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier._humidity_char = CharacteristicsTypes.RELATIVE_HUMIDITY_HUMIDIFIER_THRESHOLD

staticprivate

Definition at line 49 of file humidifier.py.

◆ _on_mode_value

int homeassistant.components.homekit_controller.humidifier.HomeKitBaseHumidifier._on_mode_value = 1

staticprivate

Definition at line 50 of file humidifier.py.

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

core/homeassistant/components/homekit_controller/humidifier.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _async_reconfigure()

◆ async_set_humidity()

◆ async_set_mode()

◆ async_turn_off()

◆ async_turn_on()

◆ current_humidity()

◆ get_characteristic_types()

◆ is_on()

◆ max_humidity()

◆ min_humidity()

◆ mode()

◆ target_humidity()

Member Data Documentation

◆ _attr_available_modes

◆ _attr_supported_features

◆ _humidity_char

◆ _on_mode_value