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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info, ZwaveHumidifierEntityDescription description)
 
None async_set_humidity (self, int humidity)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool|None is_on (self)
 
int max_humidity (self)
 
int min_humidity (self)
 
int|None target_humidity (self)
 
- Public Member Functions inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
 
None async_added_to_hass (self)
 
None async_poll_value (self, bool refresh_all_values)
 
bool available (self)
 
str generate_name (self, bool include_value_name=False, str|None alternate_value_name=None, Sequence[str|None]|None additional_info=None, str|None name_prefix=None)
 
ZwaveValue|None get_zwave_value (self, str|int value_property, int|None command_class=None, int|None endpoint=None, int|str|None value_property_key=None, bool add_to_watched_value_ids=True, bool check_all_endpoints=False)
 
None on_value_update (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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (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 Member Functions inherited from homeassistant.components.humidifier.HumidifierEntity
HumidifierAction|None action (self)
 
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)
 
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 Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
 config_entry
 
 driver
 
 info
 
 watched_value_ids
 
- 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.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
 

Private Member Functions

bool _supports_inverse_mode (self)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 
 _current_mode
 
 _setpoint
 

Detailed Description

Representation of a Z-Wave Humidifier or Dehumidifier.

Definition at line 116 of file humidifier.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.__init__ (   self,
ConfigEntry  config_entry,
Driver  driver,
ZwaveDiscoveryInfo  info,
ZwaveHumidifierEntityDescription  description 
)
Initialize humidifier.

Definition at line 123 of file humidifier.py.

Member Function Documentation

◆ _supports_inverse_mode()

bool homeassistant.components.zwave_js.humidifier.ZWaveHumidifier._supports_inverse_mode (   self)
private

Definition at line 154 of file humidifier.py.

◆ async_set_humidity()

None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.async_set_humidity (   self,
int  humidity 
)
Set new target humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 198 of file humidifier.py.

◆ async_turn_off()

None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.async_turn_off (   self,
**Any  kwargs 
)
Turn off device.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 174 of file humidifier.py.

◆ async_turn_on()

None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.async_turn_on (   self,
**Any  kwargs 
)
Turn on device.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 160 of file humidifier.py.

◆ is_on()

bool | None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.is_on (   self)
Return True if entity is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 148 of file humidifier.py.

◆ max_humidity()

int homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.max_humidity (   self)
Return the maximum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 212 of file humidifier.py.

◆ min_humidity()

int homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.min_humidity (   self)
Return the minimum humidity.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 204 of file humidifier.py.

◆ target_humidity()

int | None homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.target_humidity (   self)
Return the humidity we try to reach.

Reimplemented from homeassistant.components.humidifier.HumidifierEntity.

Definition at line 192 of file humidifier.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier._attr_name
private

Definition at line 135 of file humidifier.py.

◆ _attr_unique_id

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier._attr_unique_id
private

Definition at line 136 of file humidifier.py.

◆ _current_mode

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier._current_mode
private

Definition at line 138 of file humidifier.py.

◆ _setpoint

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier._setpoint
private

Definition at line 140 of file humidifier.py.

◆ entity_description

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.entity_description

Definition at line 133 of file humidifier.py.

◆ None

homeassistant.components.zwave_js.humidifier.ZWaveHumidifier.None
static

Definition at line 121 of file humidifier.py.


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