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

Public Member Functions

def __init__ (self, hass, object_id, config, unique_id)
 
None async_clean_spot (self, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
None async_pause (self)
 
None async_return_to_base (self, **Any kwargs)
 
None async_set_fan_speed (self, str fan_speed, **Any kwargs)
 
None async_start (self)
 
None async_stop (self, **Any kwargs)
 
str|None state (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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
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.vacuum.StateVacuumEntity
None async_send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
str battery_icon (self)
 
int|None battery_level (self)
 
dict[str, Any]|None capability_attributes (self)
 
None clean_spot (self, **Any kwargs)
 
str|None fan_speed (self)
 
list[strfan_speed_list (self)
 
None locate (self, **Any kwargs)
 
None pause (self)
 
None return_to_base (self, **Any kwargs)
 
None send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None set_fan_speed (self, str fan_speed, **Any kwargs)
 
None start (self)
 
dict[str, Any] state_attributes (self)
 
None stop (self, **Any kwargs)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Public Attributes

 entity_id
 
- 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
 
- Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 state
 

Private Member Functions

None _async_setup_templates (self)
 
def _update_battery_level (self, battery_level)
 
def _update_fan_speed (self, fan_speed)
 
def _update_state (self, result)
 

Private Attributes

 _attr_available
 
 _attr_battery_level
 
 _attr_fan_speed
 
 _attr_fan_speed_list
 
 _attr_supported_features
 
 _battery_level
 
 _battery_level_template
 
 _clean_spot_script
 
 _fan_speed_template
 
 _locate_script
 
 _pause_script
 
 _return_to_base_script
 
 _set_fan_speed_script
 
 _start_script
 
 _state
 
 _stop_script
 
 _template
 

Static Private Attributes

bool _attr_should_poll = 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.vacuum.StateVacuumEntity
 None
 
 VacuumEntityFeature
 

Detailed Description

A template vacuum component.

Definition at line 128 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 133 of file vacuum.py.

Member Function Documentation

◆ _async_setup_templates()

None homeassistant.components.template.vacuum.TemplateVacuum._async_setup_templates (   self)
private
Set up templates.

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

Definition at line 269 of file vacuum.py.

◆ _update_battery_level()

def homeassistant.components.template.vacuum.TemplateVacuum._update_battery_level (   self,
  battery_level 
)
private

Definition at line 317 of file vacuum.py.

◆ _update_fan_speed()

def homeassistant.components.template.vacuum.TemplateVacuum._update_fan_speed (   self,
  fan_speed 
)
private

Definition at line 334 of file vacuum.py.

◆ _update_state()

def homeassistant.components.template.vacuum.TemplateVacuum._update_state (   self,
  result 
)
private

Definition at line 293 of file vacuum.py.

◆ async_clean_spot()

None homeassistant.components.template.vacuum.TemplateVacuum.async_clean_spot (   self,
**Any  kwargs 
)
Perform a spot clean-up.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 234 of file vacuum.py.

◆ async_locate()

None homeassistant.components.template.vacuum.TemplateVacuum.async_locate (   self,
**Any  kwargs 
)
Locate the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 241 of file vacuum.py.

◆ async_pause()

None homeassistant.components.template.vacuum.TemplateVacuum.async_pause (   self)
Pause the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 213 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.template.vacuum.TemplateVacuum.async_return_to_base (   self,
**Any  kwargs 
)
Set the vacuum cleaner to return to the dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 227 of file vacuum.py.

◆ async_set_fan_speed()

None homeassistant.components.template.vacuum.TemplateVacuum.async_set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 248 of file vacuum.py.

◆ async_start()

None homeassistant.components.template.vacuum.TemplateVacuum.async_start (   self)
Start or resume the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 209 of file vacuum.py.

◆ async_stop()

None homeassistant.components.template.vacuum.TemplateVacuum.async_stop (   self,
**Any  kwargs 
)
Stop the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 220 of file vacuum.py.

◆ state()

str | None homeassistant.components.template.vacuum.TemplateVacuum.state (   self)
Return the status of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 205 of file vacuum.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.template.vacuum.TemplateVacuum._attr_available
private

Definition at line 299 of file vacuum.py.

◆ _attr_battery_level

homeassistant.components.template.vacuum.TemplateVacuum._attr_battery_level
private

Definition at line 328 of file vacuum.py.

◆ _attr_fan_speed

homeassistant.components.template.vacuum.TemplateVacuum._attr_fan_speed
private

Definition at line 196 of file vacuum.py.

◆ _attr_fan_speed_list

homeassistant.components.template.vacuum.TemplateVacuum._attr_fan_speed_list
private

Definition at line 202 of file vacuum.py.

◆ _attr_should_poll

bool homeassistant.components.template.vacuum.TemplateVacuum._attr_should_poll = False
staticprivate

Definition at line 131 of file vacuum.py.

◆ _attr_supported_features

homeassistant.components.template.vacuum.TemplateVacuum._attr_supported_features
private

Definition at line 152 of file vacuum.py.

◆ _battery_level

homeassistant.components.template.vacuum.TemplateVacuum._battery_level
private

Definition at line 195 of file vacuum.py.

◆ _battery_level_template

homeassistant.components.template.vacuum.TemplateVacuum._battery_level_template
private

Definition at line 150 of file vacuum.py.

◆ _clean_spot_script

homeassistant.components.template.vacuum.TemplateVacuum._clean_spot_script
private

Definition at line 175 of file vacuum.py.

◆ _fan_speed_template

homeassistant.components.template.vacuum.TemplateVacuum._fan_speed_template
private

Definition at line 151 of file vacuum.py.

◆ _locate_script

homeassistant.components.template.vacuum.TemplateVacuum._locate_script
private

Definition at line 182 of file vacuum.py.

◆ _pause_script

homeassistant.components.template.vacuum.TemplateVacuum._pause_script
private

Definition at line 158 of file vacuum.py.

◆ _return_to_base_script

homeassistant.components.template.vacuum.TemplateVacuum._return_to_base_script
private

Definition at line 168 of file vacuum.py.

◆ _set_fan_speed_script

homeassistant.components.template.vacuum.TemplateVacuum._set_fan_speed_script
private

Definition at line 187 of file vacuum.py.

◆ _start_script

homeassistant.components.template.vacuum.TemplateVacuum._start_script
private

Definition at line 156 of file vacuum.py.

◆ _state

homeassistant.components.template.vacuum.TemplateVacuum._state
private

Definition at line 194 of file vacuum.py.

◆ _stop_script

homeassistant.components.template.vacuum.TemplateVacuum._stop_script
private

Definition at line 163 of file vacuum.py.

◆ _template

homeassistant.components.template.vacuum.TemplateVacuum._template
private

Definition at line 149 of file vacuum.py.

◆ entity_id

homeassistant.components.template.vacuum.TemplateVacuum.entity_id

Definition at line 144 of file vacuum.py.


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