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

Public Member Functions

None __init__ (self, HomeAssistant hass, str unique_id, str device_name, int|None position=None, int|None tilt_position=None, CoverDeviceClass|None device_class=None, CoverEntityFeature|None supported_features=None)
 
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)
 
None async_stop_cover_tilt (self, **Any kwargs)
 
int|None current_cover_position (self)
 
int|None current_cover_tilt_position (self)
 
bool is_closed (self)
 
bool is_closing (self)
 
bool is_opening (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.cover.CoverEntity
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 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_added_to_hass (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 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 Attributes

 hass
 
- Public Attributes inherited from homeassistant.components.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _listen_cover (self)
 
None _listen_cover_tilt (self)
 
None _time_changed_cover (self, datetime now)
 
None _time_changed_cover_tilt (self, datetime now)
 

Private Attributes

 _attr_device_class
 
 _attr_device_info
 
 _attr_supported_features
 
 _closed
 
 _is_closing
 
 _is_opening
 
 _position
 
 _requested_closing
 
 _requested_closing_tilt
 
 _set_position
 
 _set_tilt_position
 
 _tilt_position
 
 _unique_id
 
 _unsub_listener_cover
 
 _unsub_listener_cover_tilt
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a demo cover.

Definition at line 58 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.cover.DemoCover.__init__ (   self,
HomeAssistant  hass,
str  unique_id,
str  device_name,
int | None   position = None,
int | None   tilt_position = None,
CoverDeviceClass | None   device_class = None,
CoverEntityFeature | None   supported_features = None 
)
Initialize the cover.

Definition at line 65 of file cover.py.

Member Function Documentation

◆ _listen_cover()

None homeassistant.components.demo.cover.DemoCover._listen_cover (   self)
private
Listen for changes in cover.

Definition at line 223 of file cover.py.

◆ _listen_cover_tilt()

None homeassistant.components.demo.cover.DemoCover._listen_cover_tilt (   self)
private
Listen for changes in cover tilt.

Definition at line 248 of file cover.py.

◆ _time_changed_cover()

None homeassistant.components.demo.cover.DemoCover._time_changed_cover (   self,
datetime  now 
)
private
Track time changes.

Definition at line 230 of file cover.py.

◆ _time_changed_cover_tilt()

None homeassistant.components.demo.cover.DemoCover._time_changed_cover_tilt (   self,
datetime  now 
)
private
Track time changes.

Definition at line 255 of file cover.py.

◆ async_close_cover()

None homeassistant.components.demo.cover.DemoCover.async_close_cover (   self,
**Any  kwargs 
)
Close the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 133 of file cover.py.

◆ async_close_cover_tilt()

None homeassistant.components.demo.cover.DemoCover.async_close_cover_tilt (   self,
**Any  kwargs 
)
Close the cover tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 147 of file cover.py.

◆ async_open_cover()

None homeassistant.components.demo.cover.DemoCover.async_open_cover (   self,
**Any  kwargs 
)
Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 155 of file cover.py.

◆ async_open_cover_tilt()

None homeassistant.components.demo.cover.DemoCover.async_open_cover_tilt (   self,
**Any  kwargs 
)
Open the cover tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 169 of file cover.py.

◆ async_set_cover_position()

None homeassistant.components.demo.cover.DemoCover.async_set_cover_position (   self,
**Any  kwargs 
)
Move the cover to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 177 of file cover.py.

◆ async_set_cover_tilt_position()

None homeassistant.components.demo.cover.DemoCover.async_set_cover_tilt_position (   self,
**Any  kwargs 
)
Move the cover til to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 189 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.demo.cover.DemoCover.async_stop_cover (   self,
**Any  kwargs 
)
Stop the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 201 of file cover.py.

◆ async_stop_cover_tilt()

None homeassistant.components.demo.cover.DemoCover.async_stop_cover_tilt (   self,
**Any  kwargs 
)
Stop the cover tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 212 of file cover.py.

◆ current_cover_position()

int | None homeassistant.components.demo.cover.DemoCover.current_cover_position (   self)
Return the current position of the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 109 of file cover.py.

◆ current_cover_tilt_position()

int | None homeassistant.components.demo.cover.DemoCover.current_cover_tilt_position (   self)
Return the current tilt position of the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 114 of file cover.py.

◆ is_closed()

bool homeassistant.components.demo.cover.DemoCover.is_closed (   self)
Return if the cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 119 of file cover.py.

◆ is_closing()

bool homeassistant.components.demo.cover.DemoCover.is_closing (   self)
Return if the cover is closing.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 124 of file cover.py.

◆ is_opening()

bool homeassistant.components.demo.cover.DemoCover.is_opening (   self)
Return if the cover is opening.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 129 of file cover.py.

◆ unique_id()

str homeassistant.components.demo.cover.DemoCover.unique_id (   self)
Return unique ID for cover.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 104 of file cover.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.demo.cover.DemoCover._attr_device_class
private

Definition at line 79 of file cover.py.

◆ _attr_device_info

homeassistant.components.demo.cover.DemoCover._attr_device_info
private

Definition at line 95 of file cover.py.

◆ _attr_has_entity_name

bool homeassistant.components.demo.cover.DemoCover._attr_has_entity_name = True
staticprivate

Definition at line 61 of file cover.py.

◆ _attr_name

homeassistant.components.demo.cover.DemoCover._attr_name = None
staticprivate

Definition at line 62 of file cover.py.

◆ _attr_should_poll

bool homeassistant.components.demo.cover.DemoCover._attr_should_poll = False
staticprivate

Definition at line 63 of file cover.py.

◆ _attr_supported_features

homeassistant.components.demo.cover.DemoCover._attr_supported_features
private

Definition at line 80 of file cover.py.

◆ _closed

homeassistant.components.demo.cover.DemoCover._closed
private

Definition at line 91 of file cover.py.

◆ _is_closing

homeassistant.components.demo.cover.DemoCover._is_closing
private

Definition at line 89 of file cover.py.

◆ _is_opening

homeassistant.components.demo.cover.DemoCover._is_opening
private

Definition at line 88 of file cover.py.

◆ _position

homeassistant.components.demo.cover.DemoCover._position
private

Definition at line 78 of file cover.py.

◆ _requested_closing

homeassistant.components.demo.cover.DemoCover._requested_closing
private

Definition at line 84 of file cover.py.

◆ _requested_closing_tilt

homeassistant.components.demo.cover.DemoCover._requested_closing_tilt
private

Definition at line 85 of file cover.py.

◆ _set_position

homeassistant.components.demo.cover.DemoCover._set_position
private

Definition at line 180 of file cover.py.

◆ _set_tilt_position

homeassistant.components.demo.cover.DemoCover._set_tilt_position
private

Definition at line 192 of file cover.py.

◆ _tilt_position

homeassistant.components.demo.cover.DemoCover._tilt_position
private

Definition at line 83 of file cover.py.

◆ _unique_id

homeassistant.components.demo.cover.DemoCover._unique_id
private

Definition at line 77 of file cover.py.

◆ _unsub_listener_cover

homeassistant.components.demo.cover.DemoCover._unsub_listener_cover
private

Definition at line 209 of file cover.py.

◆ _unsub_listener_cover_tilt

homeassistant.components.demo.cover.DemoCover._unsub_listener_cover_tilt
private

Definition at line 219 of file cover.py.

◆ hass

homeassistant.components.demo.cover.DemoCover.hass

Definition at line 76 of file cover.py.


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