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

Public Member Functions

None __init__ (self, ComelitSerialBridge coordinator, ComelitSerialBridgeObject device, str config_entry_entry_id, HumidifierComelitMode active_mode, HumidifierAction active_action, HumidifierComelitCommand set_command, HumidifierDeviceClass device_class)
 
HumidifierAction|None action (self)
 
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)
 
float current_humidity (self)
 
bool|None is_on (self)
 
str|None mode (self)
 
float target_humidity (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.comelit.coordinator.ComelitSerialBridge
None __init__ (self, HomeAssistant hass, str host, int port, int pin)
 
- Public Member Functions inherited from homeassistant.components.comelit.coordinator.ComelitBaseCoordinator
None __init__ (self, HomeAssistant hass, str device, str host)
 
dr.DeviceInfo platform_device_info (self, ComelitVedoZoneObject|ComelitVedoAreaObject|ComelitSerialBridgeObject object_class, str object_type)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
list[str]|None available_modes (self)
 
dict[str, Any] capability_attributes (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)
 

Public Attributes

 mode
 
- Public Attributes inherited from homeassistant.components.comelit.coordinator.ComelitSerialBridge
 api
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

bool _api_active (self)
 
bool _api_automatic (self)
 
str _api_mode (self)
 
list[Any] _humidifier (self)
 

Private Attributes

 _active_action
 
 _active_mode
 
 _api
 
 _api_mode
 
 _attr_device_class
 
 _attr_device_info
 
 _attr_translation_key
 
 _attr_unique_id
 
 _device
 
 _set_command
 

Static Private Attributes

list _attr_available_modes = [MODE_NORMAL, MODE_AUTO]
 
bool _attr_has_entity_name = True
 
int _attr_max_humidity = 90
 
int _attr_min_humidity = 10
 
 _attr_supported_features = HumidifierEntityFeature.MODES
 

Additional Inherited Members

- 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

Humidifier device.

Definition at line 93 of file humidifier.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.__init__ (   self,
ComelitSerialBridge  coordinator,
ComelitSerialBridgeObject  device,
str  config_entry_entry_id,
HumidifierComelitMode  active_mode,
HumidifierAction  active_action,
HumidifierComelitCommand  set_command,
HumidifierDeviceClass  device_class 
)
Init light entity.

Definition at line 102 of file humidifier.py.

Member Function Documentation

◆ _api_active()

bool homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._api_active (   self)
private

Definition at line 141 of file humidifier.py.

◆ _api_automatic()

bool homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._api_automatic (   self)
private
Return device in automatic/manual mode.

Definition at line 146 of file humidifier.py.

◆ _api_mode()

str homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._api_mode (   self)
private
Return device mode.

Definition at line 135 of file humidifier.py.

◆ _humidifier()

list[Any] homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._humidifier (   self)
private
Return humidifier device data.

Definition at line 127 of file humidifier.py.

◆ action()

HumidifierAction | None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.action (   self)
Return current action.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 171 of file humidifier.py.

◆ async_set_humidity()

None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.async_set_humidity (   self,
int  humidity 
)
Set new target humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 182 of file humidifier.py.

◆ async_set_mode()

None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.async_set_mode (   self,
str  mode 
)
Set humidifier mode.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 197 of file humidifier.py.

◆ async_turn_off()

None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.async_turn_off (   self,
**Any  kwargs 
)
Turn off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 209 of file humidifier.py.

◆ async_turn_on()

None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.async_turn_on (   self,
**Any  kwargs 
)
Turn on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 203 of file humidifier.py.

◆ current_humidity()

float homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.current_humidity (   self)
Return current humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 156 of file humidifier.py.

◆ is_on()

bool | None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.is_on (   self)
Return true is humidifier is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 161 of file humidifier.py.

◆ mode()

str | None homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.mode (   self)
Return current mode.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 166 of file humidifier.py.

◆ target_humidity()

float homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.target_humidity (   self)
Set target humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 151 of file humidifier.py.

Member Data Documentation

◆ _active_action

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._active_action
private

Definition at line 123 of file humidifier.py.

◆ _active_mode

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._active_mode
private

Definition at line 122 of file humidifier.py.

◆ _api

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._api
private

Definition at line 113 of file humidifier.py.

◆ _api_mode

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._api_mode
private

Definition at line 163 of file humidifier.py.

◆ _attr_available_modes

list homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_available_modes = [MODE_NORMAL, MODE_AUTO]
staticprivate

Definition at line 97 of file humidifier.py.

◆ _attr_device_class

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_device_class
private

Definition at line 120 of file humidifier.py.

◆ _attr_device_info

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_device_info
private

Definition at line 119 of file humidifier.py.

◆ _attr_has_entity_name

bool homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_has_entity_name = True
staticprivate

Definition at line 100 of file humidifier.py.

◆ _attr_max_humidity

int homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_max_humidity = 90
staticprivate

Definition at line 99 of file humidifier.py.

◆ _attr_min_humidity

int homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_min_humidity = 10
staticprivate

Definition at line 98 of file humidifier.py.

◆ _attr_supported_features

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_supported_features = HumidifierEntityFeature.MODES
staticprivate

Definition at line 96 of file humidifier.py.

◆ _attr_translation_key

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_translation_key
private

Definition at line 121 of file humidifier.py.

◆ _attr_unique_id

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._attr_unique_id
private

Definition at line 118 of file humidifier.py.

◆ _device

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._device
private

Definition at line 114 of file humidifier.py.

◆ _set_command

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity._set_command
private

Definition at line 124 of file humidifier.py.

◆ mode

homeassistant.components.comelit.humidifier.ComelitHumidifierEntity.mode

Definition at line 184 of file humidifier.py.


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