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

Public Member Functions

def __init__ (self, hass, object_id, config, unique_id)
 
None async_added_to_hass (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool|None is_on (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_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_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)
 
dict[str, Any]|None capability_attributes (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)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (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.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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
 

Private Member Functions

None _async_setup_templates (self)
 
def _update_state (self, result)
 

Private Attributes

 _attr_assumed_state
 
 _attr_device_info
 
 _off_script
 
 _on_script
 
 _state
 
 _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.helpers.entity.ToggleEntity
 None
 

Detailed Description

Representation of a Template switch.

Definition at line 127 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.template.switch.SwitchTemplate.__init__ (   self,
  hass,
  object_id,
  config,
  unique_id 
)
Initialize the Template switch.

Definition at line 132 of file switch.py.

Member Function Documentation

◆ _async_setup_templates()

None homeassistant.components.template.switch.SwitchTemplate._async_setup_templates (   self)
private
Set up templates.

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

Definition at line 193 of file switch.py.

◆ _update_state()

def homeassistant.components.template.switch.SwitchTemplate._update_state (   self,
  result 
)
private

Definition at line 167 of file switch.py.

◆ async_added_to_hass()

None homeassistant.components.template.switch.SwitchTemplate.async_added_to_hass (   self)
Register callbacks.

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

Definition at line 183 of file switch.py.

◆ async_turn_off()

None homeassistant.components.template.switch.SwitchTemplate.async_turn_off (   self,
**Any  kwargs 
)
Fire the off action.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 215 of file switch.py.

◆ async_turn_on()

None homeassistant.components.template.switch.SwitchTemplate.async_turn_on (   self,
**Any  kwargs 
)
Fire the on action.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 207 of file switch.py.

◆ is_on()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 203 of file switch.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.template.switch.SwitchTemplate._attr_assumed_state
private

Definition at line 160 of file switch.py.

◆ _attr_device_info

homeassistant.components.template.switch.SwitchTemplate._attr_device_info
private

Definition at line 161 of file switch.py.

◆ _attr_should_poll

bool homeassistant.components.template.switch.SwitchTemplate._attr_should_poll = False
staticprivate

Definition at line 130 of file switch.py.

◆ _off_script

homeassistant.components.template.switch.SwitchTemplate._off_script
private

Definition at line 154 of file switch.py.

◆ _on_script

homeassistant.components.template.switch.SwitchTemplate._on_script
private

Definition at line 149 of file switch.py.

◆ _state

homeassistant.components.template.switch.SwitchTemplate._state
private

Definition at line 170 of file switch.py.

◆ _template

homeassistant.components.template.switch.SwitchTemplate._template
private

Definition at line 148 of file switch.py.

◆ entity_id

homeassistant.components.template.switch.SwitchTemplate.entity_id

Definition at line 144 of file switch.py.


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