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

Public Member Functions

def __init__ (self, hass, object_id, config, unique_id)
 
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_off (self, **Any kwargs)
 
None async_turn_on (self, int|None percentage=None, str|None preset_mode=None, **Any kwargs)
 
str|None current_direction (self)
 
bool|None is_on (self)
 
bool|None oscillating (self)
 
int|None percentage (self)
 
str|None preset_mode (self)
 
list[strpreset_modes (self)
 
int speed_count (self)
 
- Public Member Functions inherited from homeassistant.components.template.template_entity.TemplateEntity
None __init__ (self, HomeAssistant hass, *Template|None availability_template=None, Template|None icon_template=None, Template|None entity_picture_template=None, dict[str, Template]|None attribute_templates=None, ConfigType|None config=None, str|None fallback_name=None, str|None unique_id=None)
 
None add_template_attribute (self, str attribute, Template template, Callable[[Any], Any]|None validator=None, Callable[[Any], None]|None on_update=None, bool none_on_template_error=False)
 
None async_added_to_hass (self)
 
None async_run_script (self, Script script, *_VarsType|None run_variables=None, Context|None context=None)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str|None, Mapping[str, Any]|None, dict[str, bool|set[str]]|None, str|None,], None,] preview_callback)
 
None async_update (self)
 
str|None referenced_blueprint (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)
 
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)
 
dict[str, list[str]|Nonecapability_attributes (self)
 
None oscillate (self, bool oscillating)
 
float percentage_step (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)
 

Public Attributes

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

Private Member Functions

None _async_setup_templates (self)
 
def _update_direction (self, direction)
 
def _update_oscillating (self, oscillating)
 
def _update_percentage (self, percentage)
 
def _update_preset_mode (self, preset_mode)
 
def _update_state (self, result)
 

Private Attributes

 _attr_assumed_state
 
 _direction
 
 _direction_template
 
 _off_script
 
 _on_script
 
 _oscillating
 
 _oscillating_template
 
 _percentage
 
 _percentage_template
 
 _preset_mode
 
 _preset_mode_template
 
 _preset_modes
 
 _set_direction_script
 
 _set_oscillating_script
 
 _set_percentage_script
 
 _set_preset_mode_script
 
 _speed_count
 
 _state
 
 _template
 

Static Private Attributes

bool _attr_should_poll = False
 
bool _enable_turn_on_off_backwards_compatibility = False
 

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 template fan component.

Definition at line 123 of file fan.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.template.fan.TemplateFan.__init__ (   self,
  hass,
  object_id,
  config,
  unique_id 
)
Initialize the fan.

Definition at line 129 of file fan.py.

Member Function Documentation

◆ _async_setup_templates()

None homeassistant.components.template.fan.TemplateFan._async_setup_templates (   self)
private
Set up templates.

Reimplemented from homeassistant.components.template.template_entity.TemplateEntity.

Definition at line 353 of file fan.py.

◆ _update_direction()

def homeassistant.components.template.fan.TemplateFan._update_direction (   self,
  direction 
)
private

Definition at line 454 of file fan.py.

◆ _update_oscillating()

def homeassistant.components.template.fan.TemplateFan._update_oscillating (   self,
  oscillating 
)
private

Definition at line 437 of file fan.py.

◆ _update_percentage()

def homeassistant.components.template.fan.TemplateFan._update_percentage (   self,
  percentage 
)
private

Definition at line 395 of file fan.py.

◆ _update_preset_mode()

def homeassistant.components.template.fan.TemplateFan._update_preset_mode (   self,
  preset_mode 
)
private

Definition at line 419 of file fan.py.

◆ _update_state()

def homeassistant.components.template.fan.TemplateFan._update_state (   self,
  result 
)
private

Definition at line 336 of file fan.py.

◆ async_oscillate()

None homeassistant.components.template.fan.TemplateFan.async_oscillate (   self,
bool  oscillating 
)
Set oscillation of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 303 of file fan.py.

◆ async_set_direction()

None homeassistant.components.template.fan.TemplateFan.async_set_direction (   self,
str  direction 
)
Set the direction of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 315 of file fan.py.

◆ async_set_percentage()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 273 of file fan.py.

◆ async_set_preset_mode()

None homeassistant.components.template.fan.TemplateFan.async_set_preset_mode (   self,
str  preset_mode 
)
Set the preset_mode of the fan.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 288 of file fan.py.

◆ async_turn_off()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 265 of file fan.py.

◆ async_turn_on()

None homeassistant.components.template.fan.TemplateFan.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 240 of file fan.py.

◆ current_direction()

str | None homeassistant.components.template.fan.TemplateFan.current_direction (   self)
Return the oscillation state.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 236 of file fan.py.

◆ is_on()

bool | None homeassistant.components.template.fan.TemplateFan.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 216 of file fan.py.

◆ oscillating()

bool | None homeassistant.components.template.fan.TemplateFan.oscillating (   self)
Return the oscillation state.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 231 of file fan.py.

◆ percentage()

int | None homeassistant.components.template.fan.TemplateFan.percentage (   self)
Return the current speed percentage.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 226 of file fan.py.

◆ preset_mode()

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

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 221 of file fan.py.

◆ preset_modes()

list[str] homeassistant.components.template.fan.TemplateFan.preset_modes (   self)
Get the list of available preset modes.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 211 of file fan.py.

◆ speed_count()

int homeassistant.components.template.fan.TemplateFan.speed_count (   self)
Return the number of speeds the fan supports.

Reimplemented from homeassistant.components.fan.FanEntity.

Definition at line 206 of file fan.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.template.fan.TemplateFan._attr_assumed_state
private

Definition at line 203 of file fan.py.

◆ _attr_should_poll

bool homeassistant.components.template.fan.TemplateFan._attr_should_poll = False
staticprivate

Definition at line 126 of file fan.py.

◆ _direction

homeassistant.components.template.fan.TemplateFan._direction
private

Definition at line 183 of file fan.py.

◆ _direction_template

homeassistant.components.template.fan.TemplateFan._direction_template
private

Definition at line 150 of file fan.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.template.fan.TemplateFan._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 127 of file fan.py.

◆ _off_script

homeassistant.components.template.fan.TemplateFan._off_script
private

Definition at line 153 of file fan.py.

◆ _on_script

homeassistant.components.template.fan.TemplateFan._on_script
private

Definition at line 152 of file fan.py.

◆ _oscillating

homeassistant.components.template.fan.TemplateFan._oscillating
private

Definition at line 182 of file fan.py.

◆ _oscillating_template

homeassistant.components.template.fan.TemplateFan._oscillating_template
private

Definition at line 149 of file fan.py.

◆ _percentage

homeassistant.components.template.fan.TemplateFan._percentage
private

Definition at line 180 of file fan.py.

◆ _percentage_template

homeassistant.components.template.fan.TemplateFan._percentage_template
private

Definition at line 147 of file fan.py.

◆ _preset_mode

homeassistant.components.template.fan.TemplateFan._preset_mode
private

Definition at line 181 of file fan.py.

◆ _preset_mode_template

homeassistant.components.template.fan.TemplateFan._preset_mode_template
private

Definition at line 148 of file fan.py.

◆ _preset_modes

homeassistant.components.template.fan.TemplateFan._preset_modes
private

Definition at line 189 of file fan.py.

◆ _set_direction_script

homeassistant.components.template.fan.TemplateFan._set_direction_script
private

Definition at line 173 of file fan.py.

◆ _set_oscillating_script

homeassistant.components.template.fan.TemplateFan._set_oscillating_script
private

Definition at line 167 of file fan.py.

◆ _set_percentage_script

homeassistant.components.template.fan.TemplateFan._set_percentage_script
private

Definition at line 155 of file fan.py.

◆ _set_preset_mode_script

homeassistant.components.template.fan.TemplateFan._set_preset_mode_script
private

Definition at line 161 of file fan.py.

◆ _speed_count

homeassistant.components.template.fan.TemplateFan._speed_count
private

Definition at line 186 of file fan.py.

◆ _state

homeassistant.components.template.fan.TemplateFan._state
private

Definition at line 262 of file fan.py.

◆ _template

homeassistant.components.template.fan.TemplateFan._template
private

Definition at line 146 of file fan.py.

◆ entity_id

homeassistant.components.template.fan.TemplateFan.entity_id

Definition at line 141 of file fan.py.

◆ hass

homeassistant.components.template.fan.TemplateFan.hass

Definition at line 140 of file fan.py.


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