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

Public Member Functions

None async_oscillate (self, bool oscillating)
 
None async_set_direction (self, str direction)
 
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)
 
str current_direction (self)
 
list[strget_characteristic_types (self)
 
bool is_on (self)
 
bool oscillating (self)
 
int percentage (self)
 
int speed_count (self)
 
FanEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo)
 
None async_added_to_hass (self)
 
None async_put_characteristics (self, dict[str, Any] characteristics)
 
None async_setup (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
str|None default_name (self)
 
DeviceInfo device_info (self)
 
str|None name (self)
 
str old_unique_id (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_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)
 
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_set_preset_mode (self, str preset_mode)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
None oscillate (self, bool oscillating)
 
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)
 
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)
 

Private Member Functions

None _async_reconfigure (self)
 
int _max_speed (self)
 
int _min_speed (self)
 
tuple[int, int_speed_range (self)
 

Static Private Attributes

bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
 accessory
 
 accessory_info
 
 all_characteristics
 
 all_iids
 
 pollable_characteristics
 
 service
 
 watchable_characteristics
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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

Representation of a Homekit fan.

Definition at line 39 of file fan.py.

Member Function Documentation

◆ _async_reconfigure()

None homeassistant.components.homekit_controller.fan.BaseHomeKitFan._async_reconfigure (   self)
private
Reconfigure entity.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 48 of file fan.py.

◆ _max_speed()

int homeassistant.components.homekit_controller.fan.BaseHomeKitFan._max_speed (   self)
private
Return the minimum speed.

Definition at line 88 of file fan.py.

◆ _min_speed()

int homeassistant.components.homekit_controller.fan.BaseHomeKitFan._min_speed (   self)
private
Return the minimum speed.

Definition at line 81 of file fan.py.

◆ _speed_range()

tuple[int, int] homeassistant.components.homekit_controller.fan.BaseHomeKitFan._speed_range (   self)
private
Return the speed range.

Definition at line 76 of file fan.py.

◆ async_oscillate()

None homeassistant.components.homekit_controller.fan.BaseHomeKitFan.async_oscillate (   self,
bool  oscillating 
)
Oscillate the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 158 of file fan.py.

◆ async_set_direction()

None homeassistant.components.homekit_controller.fan.BaseHomeKitFan.async_set_direction (   self,
str  direction 
)
Set the direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 138 of file fan.py.

◆ async_set_percentage()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 144 of file fan.py.

◆ async_turn_off()

None homeassistant.components.homekit_controller.fan.BaseHomeKitFan.async_turn_off (   self,
**Any  kwargs 
)
Turn the specified fan off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 187 of file fan.py.

◆ async_turn_on()

None homeassistant.components.homekit_controller.fan.BaseHomeKitFan.async_turn_on (   self,
int | None   percentage = None,
str | None   preset_mode = None,
**Any  kwargs 
)
Turn the specified fan on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 164 of file fan.py.

◆ current_direction()

str homeassistant.components.homekit_controller.fan.BaseHomeKitFan.current_direction (   self)
Return the current direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 103 of file fan.py.

◆ get_characteristic_types()

list[str] homeassistant.components.homekit_controller.fan.BaseHomeKitFan.get_characteristic_types (   self)
Define the homekit characteristics the entity cares about.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 61 of file fan.py.

◆ is_on()

bool homeassistant.components.homekit_controller.fan.BaseHomeKitFan.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 71 of file fan.py.

◆ oscillating()

bool homeassistant.components.homekit_controller.fan.BaseHomeKitFan.oscillating (   self)
Return whether or not the fan is currently oscillating.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 109 of file fan.py.

◆ percentage()

int homeassistant.components.homekit_controller.fan.BaseHomeKitFan.percentage (   self)
Return the current speed percentage.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 93 of file fan.py.

◆ speed_count()

int homeassistant.components.homekit_controller.fan.BaseHomeKitFan.speed_count (   self)
Speed count for the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 131 of file fan.py.

◆ supported_features()

FanEntityFeature homeassistant.components.homekit_controller.fan.BaseHomeKitFan.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 115 of file fan.py.

Member Data Documentation

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.homekit_controller.fan.BaseHomeKitFan._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 45 of file fan.py.


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