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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
dict[str, strextra_state_attributes (self)
 
str|None fan_state (self)
 
bool|None is_on (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
FanEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
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)
 
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)
 
str|None device_class (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)
 
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.fan.FanEntity
Any __getattribute__ (self, str name)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_decrease_speed (self, int|None percentage_step=None)
 
None async_handle_set_preset_mode_service (self, str preset_mode)
 
None async_handle_turn_on_service (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
None async_increase_speed (self, int|None percentage_step=None)
 
None async_oscillate (self, bool oscillating)
 
None async_set_direction (self, str direction)
 
None async_set_percentage (self, int percentage)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
str|None current_direction (self)
 
None oscillate (self, bool oscillating)
 
bool|None oscillating (self)
 
int|None percentage (self)
 
float percentage_step (self)
 
None set_direction (self, str direction)
 
None set_percentage (self, int percentage)
 
None set_preset_mode (self, str preset_mode)
 
int speed_count (self)
 
dict[str, float|str|Nonestate_attributes (self)
 
None turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
None async_turn_on (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)
 

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.fan.FanEntity
 bool
 
 FanEntityFeature
 
 int
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Private Attributes

 _fan_mode
 
 _fan_off
 
 _fan_state
 

Additional Inherited Members

- 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
 

Detailed Description

Representation of a Z-Wave thermostat fan.

Definition at line 312 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.__init__ (   self,
ConfigEntry  config_entry,
Driver  driver,
ZwaveDiscoveryInfo   info 
)
Initialize the thermostat fan.

Reimplemented from homeassistant.components.zwave_js.entity.ZWaveBaseEntity.

Definition at line 319 of file fan.py.

Member Function Documentation

◆ async_set_preset_mode()

None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.async_set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 370 of file fan.py.

◆ async_turn_off()

None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.async_turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 349 of file fan.py.

◆ async_turn_on()

None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.async_turn_on (   self,
int | None   percentage = None,
str | None   preset_mode = None,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 338 of file fan.py.

◆ extra_state_attributes()

dict[str, str] homeassistant.components.zwave_js.fan.ZwaveThermostatFan.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 415 of file fan.py.

◆ fan_state()

str | None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.fan_state (   self)
Return the current state, Idle, Running, etc.

Definition at line 403 of file fan.py.

◆ is_on()

bool | None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 356 of file fan.py.

◆ preset_mode()

str | None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.preset_mode (   self)
Return the current preset mode, e.g., auto, smart, interval, favorite.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 363 of file fan.py.

◆ preset_modes()

list[str] | None homeassistant.components.zwave_js.fan.ZwaveThermostatFan.preset_modes (   self)
Return a list of available preset modes.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 385 of file fan.py.

◆ supported_features()

FanEntityFeature homeassistant.components.zwave_js.fan.ZwaveThermostatFan.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 392 of file fan.py.

Member Data Documentation

◆ _fan_mode

homeassistant.components.zwave_js.fan.ZwaveThermostatFan._fan_mode
private

Definition at line 325 of file fan.py.

◆ _fan_off

homeassistant.components.zwave_js.fan.ZwaveThermostatFan._fan_off
private

Definition at line 327 of file fan.py.

◆ _fan_state

homeassistant.components.zwave_js.fan.ZwaveThermostatFan._fan_state
private

Definition at line 332 of file fan.py.

◆ None

homeassistant.components.zwave_js.fan.ZwaveThermostatFan.None
static

Definition at line 316 of file fan.py.


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