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

Public Member Functions

None __init__ (self, DeviceDataUpdateCoordinator coordinator, FanEntityDescription entity_description, str property_id)
 
None async_set_percentage (self, int percentage)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.lg_thinq.entity.ThinQEntity
None __init__ (self, DeviceDataUpdateCoordinator coordinator, EntityDescription entity_description, str property_id)
 
None async_added_to_hass (self)
 
None async_call_api (self, Coroutine[Any, Any, Any] target, Callable[[], None]|None on_fail_method=None)
 
PropertyState data (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.lg_thinq.coordinator.DeviceDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, HABridge ha_bridge)
 
None handle_notification_message (self, str|None message)
 
None handle_update_status (self, dict[str, Any] status)
 
None refresh_status (self)
 
- 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.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_preset_mode (self, str preset_mode)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
str|None current_direction (self)
 
bool|None is_on (self)
 
None oscillate (self, bool oscillating)
 
bool|None oscillating (self)
 
int|None percentage (self)
 
float percentage_step (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (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)
 
FanEntityFeature supported_features (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 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_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)
 
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 Attributes

 speed_count
 
- Public Attributes inherited from homeassistant.components.lg_thinq.entity.ThinQEntity
 entity_description
 
 location
 
 property_id
 
- Public Attributes inherited from homeassistant.components.lg_thinq.coordinator.DeviceDataUpdateCoordinator
 api
 
 data
 
 device_id
 
 device_name
 
 sub_id
 
 unique_id
 
- 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

None _update_status (self)
 

Private Attributes

 _attr_is_on
 
 _attr_percentage
 
 _attr_speed_count
 
 _attr_supported_features
 
 _ordered_named_fan_speeds
 

Additional Inherited Members

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

Represent a thinq fan platform.

Definition at line 62 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lg_thinq.fan.ThinQFanEntity.__init__ (   self,
DeviceDataUpdateCoordinator  coordinator,
FanEntityDescription  entity_description,
str  property_id 
)
Initialize fan platform.

Definition at line 65 of file fan.py.

Member Function Documentation

◆ _update_status()

None homeassistant.components.lg_thinq.fan.ThinQFanEntity._update_status (   self)
private
Update status itself.

Reimplemented from homeassistant.components.lg_thinq.entity.ThinQEntity.

Definition at line 85 of file fan.py.

◆ async_set_percentage()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 112 of file fan.py.

◆ async_turn_off()

None homeassistant.components.lg_thinq.fan.ThinQFanEntity.async_turn_off (   self,
**Any  kwargs 
)
Turn the fan off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 148 of file fan.py.

◆ async_turn_on()

None homeassistant.components.lg_thinq.fan.ThinQFanEntity.async_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 136 of file fan.py.

Member Data Documentation

◆ _attr_is_on

homeassistant.components.lg_thinq.fan.ThinQFanEntity._attr_is_on
private

Definition at line 90 of file fan.py.

◆ _attr_percentage

homeassistant.components.lg_thinq.fan.ThinQFanEntity._attr_percentage
private

Definition at line 97 of file fan.py.

◆ _attr_speed_count

homeassistant.components.lg_thinq.fan.ThinQFanEntity._attr_speed_count
private

Definition at line 81 of file fan.py.

◆ _attr_supported_features

homeassistant.components.lg_thinq.fan.ThinQFanEntity._attr_supported_features
private

Definition at line 75 of file fan.py.

◆ _ordered_named_fan_speeds

homeassistant.components.lg_thinq.fan.ThinQFanEntity._ordered_named_fan_speeds
private

Definition at line 74 of file fan.py.

◆ speed_count

homeassistant.components.lg_thinq.fan.ThinQFanEntity.speed_count

Definition at line 82 of file fan.py.


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