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

Public Member Functions

None __init__ (self, str|None unique_id, str name, list[str] entities)
 
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)
 
None async_update_group_state (self)
 
None async_update_supported_features (self, str entity_id, State|None new_state)
 
str|None current_direction (self)
 
bool|None is_on (self)
 
bool|None oscillating (self)
 
int|None percentage (self)
 
int speed_count (self)
 
- Public Member Functions inherited from homeassistant.components.group.entity.GroupEntity
None async_added_to_hass (self)
 
None async_defer_or_update_ha_state (self)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
 
- 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)
 
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 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)
 
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)
 

Static Public Attributes

 bool
 
- 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 Member Functions

None _async_call_all_entities (self, str service)
 
None _async_call_supported_entities (self, str service, int support_flag, dict[str, Any] data)
 
list[State_async_states_by_support_flag (self, int flag)
 
None _set_attr_most_frequent (self, str attr, int flag, str entity_attr)
 

Private Attributes

 _attr_available
 
 _attr_extra_state_attributes
 
 _attr_name
 
 _attr_supported_features
 
 _attr_unique_id
 
 _direction
 
 _entity_ids
 
 _is_on
 
 _oscillating
 
 _percentage
 
 _speed_count
 

Static Private Attributes

bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a FanGroup.

Definition at line 108 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.group.fan.FanGroup.__init__ (   self,
str | None  unique_id,
str  name,
list[str entities 
)
Initialize a FanGroup entity.

Definition at line 114 of file fan.py.

Member Function Documentation

◆ _async_call_all_entities()

None homeassistant.components.group.fan.FanGroup._async_call_all_entities (   self,
str  service 
)
private
Call a service with all entities.

Definition at line 228 of file fan.py.

◆ _async_call_supported_entities()

None homeassistant.components.group.fan.FanGroup._async_call_supported_entities (   self,
str  service,
int  support_flag,
dict[str, Any]   data 
)
private
Call a service with all entities.

Definition at line 216 of file fan.py.

◆ _async_states_by_support_flag()

list[State] homeassistant.components.group.fan.FanGroup._async_states_by_support_flag (   self,
int  flag 
)
private
Return all the entity states for a supported flag.

Definition at line 238 of file fan.py.

◆ _set_attr_most_frequent()

None homeassistant.components.group.fan.FanGroup._set_attr_most_frequent (   self,
str  attr,
int  flag,
str  entity_attr 
)
private
Set an attribute based on most frequent supported entities attributes.

Definition at line 245 of file fan.py.

◆ async_oscillate()

None homeassistant.components.group.fan.FanGroup.async_oscillate (   self,
bool  oscillating 
)
Oscillate the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 180 of file fan.py.

◆ async_set_direction()

None homeassistant.components.group.fan.FanGroup.async_set_direction (   self,
str  direction 
)
Set the direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 188 of file fan.py.

◆ async_set_percentage()

None homeassistant.components.group.fan.FanGroup.async_set_percentage (   self,
int  percentage 
)
Set the speed of the fan, as a percentage.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 170 of file fan.py.

◆ async_turn_off()

None homeassistant.components.group.fan.FanGroup.async_turn_off (   self,
**Any  kwargs 
)
Turn the fans off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 210 of file fan.py.

◆ async_turn_on()

None homeassistant.components.group.fan.FanGroup.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 196 of file fan.py.

◆ async_update_group_state()

None homeassistant.components.group.fan.FanGroup.async_update_group_state (   self)
Update state and attributes.

Reimplemented from homeassistant.components.group.entity.GroupEntity.

Definition at line 251 of file fan.py.

◆ async_update_supported_features()

None homeassistant.components.group.fan.FanGroup.async_update_supported_features (   self,
str  entity_id,
State | None  new_state 
)
Update dictionaries with supported features.

Reimplemented from homeassistant.components.group.entity.GroupEntity.

Definition at line 153 of file fan.py.

◆ current_direction()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 143 of file fan.py.

◆ is_on()

bool | None homeassistant.components.group.fan.FanGroup.is_on (   self)
Return true if the entity is on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 133 of file fan.py.

◆ oscillating()

bool | None homeassistant.components.group.fan.FanGroup.oscillating (   self)
Return whether or not the fan is currently oscillating.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 148 of file fan.py.

◆ percentage()

int | None homeassistant.components.group.fan.FanGroup.percentage (   self)
Return the current speed as a percentage.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 138 of file fan.py.

◆ speed_count()

int homeassistant.components.group.fan.FanGroup.speed_count (   self)
Return the number of speeds the fan supports.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 128 of file fan.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.group.fan.FanGroup._attr_available
private

Definition at line 261 of file fan.py.

◆ _attr_extra_state_attributes

homeassistant.components.group.fan.FanGroup._attr_extra_state_attributes
private

Definition at line 124 of file fan.py.

◆ _attr_name

homeassistant.components.group.fan.FanGroup._attr_name
private

Definition at line 123 of file fan.py.

◆ _attr_supported_features

homeassistant.components.group.fan.FanGroup._attr_supported_features
private

Definition at line 296 of file fan.py.

◆ _attr_unique_id

homeassistant.components.group.fan.FanGroup._attr_unique_id
private

Definition at line 125 of file fan.py.

◆ _direction

homeassistant.components.group.fan.FanGroup._direction
private

Definition at line 120 of file fan.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.group.fan.FanGroup._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 112 of file fan.py.

◆ _entity_ids

homeassistant.components.group.fan.FanGroup._entity_ids
private

Definition at line 116 of file fan.py.

◆ _is_on

homeassistant.components.group.fan.FanGroup._is_on
private

Definition at line 268 of file fan.py.

◆ _oscillating

homeassistant.components.group.fan.FanGroup._oscillating
private

Definition at line 119 of file fan.py.

◆ _percentage

homeassistant.components.group.fan.FanGroup._percentage
private

Definition at line 118 of file fan.py.

◆ _speed_count

homeassistant.components.group.fan.FanGroup._speed_count
private

Definition at line 121 of file fan.py.

◆ bool

homeassistant.components.group.fan.FanGroup.bool
static

Definition at line 111 of file fan.py.


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