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

Public Member Functions

None __init__ (self, CustomerDevice device, Manager device_manager)
 
str|None current_direction (self)
 
bool|None is_on (self)
 
None oscillate (self, bool oscillating)
 
bool|None oscillating (self)
 
int|None percentage (self)
 
str|None preset_mode (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)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.tuya.entity.TuyaEntity
None async_added_to_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
DPCode|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False)
 
DPCode|EnumTypeData|IntegerTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, DPType|None dptype=None)
 
EnumTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, Literal[DPType.ENUM] dptype)
 
IntegerTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, Literal[DPType.INTEGER] dptype)
 
DPType|None get_dptype (self, DPCode|None dpcode, bool prefer_function=False)
 
- 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)
 
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)
 
None async_set_percentage (self, int percentage)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
float percentage_step (self)
 
list[str]|None preset_modes (self)
 
dict[str, float|str|Nonestate_attributes (self)
 
FanEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (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

 _attr_preset_modes
 
 _direction
 
 _oscillate
 
 _presets
 
 _speed
 
 _speeds
 
 _switch
 

Static Private Attributes

 _attr_name = None
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.tuya.entity.TuyaEntity
 device
 
 device_manager
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Tuya Fan Device.

Definition at line 59 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tuya.fan.TuyaFanEntity.__init__ (   self,
CustomerDevice  device,
Manager  device_manager 
)
Init Tuya Fan Device.

Reimplemented from homeassistant.components.tuya.entity.TuyaEntity.

Definition at line 71 of file fan.py.

Member Function Documentation

◆ current_direction()

str | None homeassistant.components.tuya.fan.TuyaFanEntity.current_direction (   self)
Return the current direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 217 of file fan.py.

◆ is_on()

bool | None homeassistant.components.tuya.fan.TuyaFanEntity.is_on (   self)
Return true if fan is on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 210 of file fan.py.

◆ oscillate()

None homeassistant.components.tuya.fan.TuyaFanEntity.oscillate (   self,
bool  oscillating 
)
Oscillate the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 203 of file fan.py.

◆ oscillating()

bool | None homeassistant.components.tuya.fan.TuyaFanEntity.oscillating (   self)
Return true if the fan is oscillating.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 234 of file fan.py.

◆ percentage()

int | None homeassistant.components.tuya.fan.TuyaFanEntity.percentage (   self)
Return the current speed.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 248 of file fan.py.

◆ preset_mode()

str | None homeassistant.components.tuya.fan.TuyaFanEntity.preset_mode (   self)
Return the current preset_mode.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 241 of file fan.py.

◆ set_direction()

None homeassistant.components.tuya.fan.TuyaFanEntity.set_direction (   self,
str  direction 
)
Set the direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 131 of file fan.py.

◆ set_percentage()

None homeassistant.components.tuya.fan.TuyaFanEntity.set_percentage (   self,
int  percentage 
)
Set the speed of the fan, as a percentage.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 137 of file fan.py.

◆ set_preset_mode()

None homeassistant.components.tuya.fan.TuyaFanEntity.set_preset_mode (   self,
str  preset_mode 
)
Set the preset mode of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 125 of file fan.py.

◆ speed_count()

int homeassistant.components.tuya.fan.TuyaFanEntity.speed_count (   self)
Return the number of speeds the fan supports.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 263 of file fan.py.

◆ turn_off()

None homeassistant.components.tuya.fan.TuyaFanEntity.turn_off (   self,
**Any  kwargs 
)
Turn the fan off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 162 of file fan.py.

◆ turn_on()

None homeassistant.components.tuya.fan.TuyaFanEntity.turn_on (   self,
int | None   percentage = None,
str | None   preset_mode = None,
**Any  kwargs 
)
Turn on the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 166 of file fan.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.tuya.fan.TuyaFanEntity._attr_name = None
staticprivate

Definition at line 68 of file fan.py.

◆ _attr_preset_modes

homeassistant.components.tuya.fan.TuyaFanEntity._attr_preset_modes
private

Definition at line 83 of file fan.py.

◆ _direction

homeassistant.components.tuya.fan.TuyaFanEntity._direction
private

Definition at line 118 of file fan.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.tuya.fan.TuyaFanEntity._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 69 of file fan.py.

◆ _oscillate

homeassistant.components.tuya.fan.TuyaFanEntity._oscillate
private

Definition at line 112 of file fan.py.

◆ _presets

homeassistant.components.tuya.fan.TuyaFanEntity._presets
private

Definition at line 87 of file fan.py.

◆ _speed

homeassistant.components.tuya.fan.TuyaFanEntity._speed
private

Definition at line 102 of file fan.py.

◆ _speeds

homeassistant.components.tuya.fan.TuyaFanEntity._speeds
private

Definition at line 107 of file fan.py.

◆ _switch

homeassistant.components.tuya.fan.TuyaFanEntity._switch
private

Definition at line 79 of file fan.py.

◆ None

homeassistant.components.tuya.fan.TuyaFanEntity.None
static

Definition at line 62 of file fan.py.


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