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

Public Member Functions

def __init__ (self, hass, object_id, config, unique_id)
 
None async_close_cover (self, **Any kwargs)
 
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_open_cover_tilt (self, **Any kwargs)
 
None async_set_cover_position (self, **Any kwargs)
 
None async_set_cover_tilt_position (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
int|None current_cover_position (self)
 
int|None current_cover_tilt_position (self)
 
bool|None is_closed (self)
 
bool is_closing (self)
 
bool is_opening (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)
 
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)
 
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.cover.CoverEntity
None async_stop_cover_tilt (self, **Any kwargs)
 
None async_toggle (self, **Any kwargs)
 
None async_toggle_tilt (self, **Any kwargs)
 
None close_cover (self, **Any kwargs)
 
None close_cover_tilt (self, **Any kwargs)
 
CoverDeviceClass|None device_class (self)
 
None open_cover (self, **Any kwargs)
 
None open_cover_tilt (self, **Any kwargs)
 
None set_cover_position (self, **Any kwargs)
 
None set_cover_tilt_position (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop_cover (self, **Any kwargs)
 
None stop_cover_tilt (self, **Any kwargs)
 
CoverEntityFeature supported_features (self)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (self, **Any kwargs)
 

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.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 

Private Member Functions

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

Private Attributes

 _attr_device_class
 
 _attr_supported_features
 
 _close_script
 
 _is_closing
 
 _is_opening
 
 _open_script
 
 _optimistic
 
 _position
 
 _position_script
 
 _position_template
 
 _stop_script
 
 _template
 
 _tilt_optimistic
 
 _tilt_script
 
 _tilt_template
 
 _tilt_value
 

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.cover.CoverEntity
 None
 

Detailed Description

Representation of a Template cover.

Definition at line 137 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 142 of file cover.py.

Member Function Documentation

◆ _async_setup_templates()

None homeassistant.components.template.cover.CoverTemplate._async_setup_templates (   self)
private
Set up templates.

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

Definition at line 197 of file cover.py.

◆ _update_position()

def homeassistant.components.template.cover.CoverTemplate._update_position (   self,
  result 
)
private

Definition at line 253 of file cover.py.

◆ _update_state()

def homeassistant.components.template.cover.CoverTemplate._update_state (   self,
  result 
)
private

Definition at line 222 of file cover.py.

◆ _update_tilt()

def homeassistant.components.template.cover.CoverTemplate._update_tilt (   self,
  result 
)
private

Definition at line 275 of file cover.py.

◆ async_close_cover()

None homeassistant.components.template.cover.CoverTemplate.async_close_cover (   self,
**Any  kwargs 
)
Move the cover down.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 346 of file cover.py.

◆ async_close_cover_tilt()

None homeassistant.components.template.cover.CoverTemplate.async_close_cover_tilt (   self,
**Any  kwargs 
)
Tilt the cover closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 387 of file cover.py.

◆ async_open_cover()

None homeassistant.components.template.cover.CoverTemplate.async_open_cover (   self,
**Any  kwargs 
)
Move the cover up.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 332 of file cover.py.

◆ async_open_cover_tilt()

None homeassistant.components.template.cover.CoverTemplate.async_open_cover_tilt (   self,
**Any  kwargs 
)
Tilt the cover open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 376 of file cover.py.

◆ async_set_cover_position()

None homeassistant.components.template.cover.CoverTemplate.async_set_cover_position (   self,
**Any  kwargs 
)
Set cover position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 365 of file cover.py.

◆ async_set_cover_tilt_position()

None homeassistant.components.template.cover.CoverTemplate.async_set_cover_tilt_position (   self,
**Any  kwargs 
)
Move the cover tilt to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 398 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.template.cover.CoverTemplate.async_stop_cover (   self,
**Any  kwargs 
)
Fire the stop action.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 360 of file cover.py.

◆ current_cover_position()

int | None homeassistant.components.template.cover.CoverTemplate.current_cover_position (   self)
Return current position of cover.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 315 of file cover.py.

◆ current_cover_tilt_position()

int | None homeassistant.components.template.cover.CoverTemplate.current_cover_tilt_position (   self)
Return current position of cover tilt.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 325 of file cover.py.

◆ is_closed()

bool | None homeassistant.components.template.cover.CoverTemplate.is_closed (   self)
Return if the cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 297 of file cover.py.

◆ is_closing()

bool homeassistant.components.template.cover.CoverTemplate.is_closing (   self)
Return if the cover is currently closing.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 310 of file cover.py.

◆ is_opening()

bool homeassistant.components.template.cover.CoverTemplate.is_opening (   self)
Return if the cover is currently opening.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 305 of file cover.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.template.cover.CoverTemplate._attr_device_class
private

Definition at line 160 of file cover.py.

◆ _attr_should_poll

bool homeassistant.components.template.cover.CoverTemplate._attr_should_poll = False
staticprivate

Definition at line 140 of file cover.py.

◆ _attr_supported_features

homeassistant.components.template.cover.CoverTemplate._attr_supported_features
private

Definition at line 194 of file cover.py.

◆ _close_script

homeassistant.components.template.cover.CoverTemplate._close_script
private

Definition at line 164 of file cover.py.

◆ _is_closing

homeassistant.components.template.cover.CoverTemplate._is_closing
private

Definition at line 184 of file cover.py.

◆ _is_opening

homeassistant.components.template.cover.CoverTemplate._is_opening
private

Definition at line 183 of file cover.py.

◆ _open_script

homeassistant.components.template.cover.CoverTemplate._open_script
private

Definition at line 161 of file cover.py.

◆ _optimistic

homeassistant.components.template.cover.CoverTemplate._optimistic
private

Definition at line 177 of file cover.py.

◆ _position

homeassistant.components.template.cover.CoverTemplate._position
private

Definition at line 182 of file cover.py.

◆ _position_script

homeassistant.components.template.cover.CoverTemplate._position_script
private

Definition at line 170 of file cover.py.

◆ _position_template

homeassistant.components.template.cover.CoverTemplate._position_template
private

Definition at line 158 of file cover.py.

◆ _stop_script

homeassistant.components.template.cover.CoverTemplate._stop_script
private

Definition at line 167 of file cover.py.

◆ _template

homeassistant.components.template.cover.CoverTemplate._template
private

Definition at line 157 of file cover.py.

◆ _tilt_optimistic

homeassistant.components.template.cover.CoverTemplate._tilt_optimistic
private

Definition at line 181 of file cover.py.

◆ _tilt_script

homeassistant.components.template.cover.CoverTemplate._tilt_script
private

Definition at line 173 of file cover.py.

◆ _tilt_template

homeassistant.components.template.cover.CoverTemplate._tilt_template
private

Definition at line 159 of file cover.py.

◆ _tilt_value

homeassistant.components.template.cover.CoverTemplate._tilt_value
private

Definition at line 185 of file cover.py.

◆ entity_id

homeassistant.components.template.cover.CoverTemplate.entity_id

Definition at line 153 of file cover.py.


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