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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
 
None async_set_percentage (self, int percentage)
 
None async_set_preset_mode (self, str preset_mode)
 
bool available (self)
 
FanValueMapping fan_value_mapping (self)
 
bool has_fan_value_mapping (self)
 
int|None percentage (self)
 
float percentage_step (self)
 
int percentage_to_zwave_speed (self, int percentage)
 
str|None preset_mode (self)
 
list[strpreset_modes (self)
 
int speed_count (self)
 
FanEntityFeature supported_features (self)
 
int|None zwave_speed_to_percentage (self, int zwave_speed)
 
- Public Member Functions inherited from homeassistant.components.zwave_js.fan.ZwaveFan
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
bool|None is_on (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)
 
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)
 
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.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)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
str|None current_direction (self)
 
None oscillate (self, bool oscillating)
 
bool|None oscillating (self)
 
None set_direction (self, str direction)
 
None set_percentage (self, int percentage)
 
None set_preset_mode (self, str preset_mode)
 
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)
 

Public Attributes

 data_template
 
- 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
 

Additional Inherited Members

- 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
 

Detailed Description

A Zwave fan with a value mapping data (e.g., 1-24 is low).

Definition at line 165 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from homeassistant.components.zwave_js.fan.ZwaveFan.

Definition at line 168 of file fan.py.

Member Function Documentation

◆ async_set_percentage()

None homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.async_set_percentage (   self,
int  percentage 
)
Set the speed percentage of the fan.

Reimplemented from homeassistant.components.zwave_js.fan.ZwaveFan.

Definition at line 177 of file fan.py.

◆ async_set_preset_mode()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 182 of file fan.py.

◆ available()

bool homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.available (   self)
Return whether the entity is available.

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

Definition at line 190 of file fan.py.

◆ fan_value_mapping()

FanValueMapping homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.fan_value_mapping (   self)
Return the speed configuration for this fan.

Definition at line 238 of file fan.py.

◆ has_fan_value_mapping()

bool homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.has_fan_value_mapping (   self)
Check if the speed configuration is valid.

Definition at line 230 of file fan.py.

◆ percentage()

int | None homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.percentage (   self)
Return the current speed percentage.

Reimplemented from homeassistant.components.zwave_js.fan.ZwaveFan.

Definition at line 195 of file fan.py.

◆ percentage_step()

float homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.percentage_step (   self)
Return the step size for percentage.

Reimplemented from homeassistant.components.zwave_js.fan.ZwaveFan.

Definition at line 207 of file fan.py.

◆ percentage_to_zwave_speed()

int homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.percentage_to_zwave_speed (   self,
int  percentage 
)
Map a percentage to a ZWave speed.

Definition at line 267 of file fan.py.

◆ preset_mode()

str | None homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.preset_mode (   self)
Return the current preset mode.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 223 of file fan.py.

◆ preset_modes()

list[str] homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.preset_modes (   self)
Return the available preset modes.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 215 of file fan.py.

◆ speed_count()

int homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.speed_count (   self)
Return the number of speeds the fan supports.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 250 of file fan.py.

◆ supported_features()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 255 of file fan.py.

◆ zwave_speed_to_percentage()

int | None homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.zwave_speed_to_percentage (   self,
int  zwave_speed 
)
Convert a Zwave speed to a percentage.

This method may return None if the device's value mapping doesn't cover
the specified Z-Wave speed.

Definition at line 289 of file fan.py.

Member Data Documentation

◆ data_template

homeassistant.components.zwave_js.fan.ValueMappingZwaveFan.data_template

Definition at line 173 of file fan.py.


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