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

Public Member Functions

None __init__ (self, AdsHub ads_hub, str ads_var_is_closed, str|None ads_var_position, str|None ads_var_pos_set, str|None ads_var_open, str|None ads_var_close, str|None ads_var_stop, str name, CoverDeviceClass|None device_class)
 
None async_added_to_hass (self)
 
bool available (self)
 
None close_cover (self, **Any kwargs)
 
int current_cover_position (self)
 
bool|None is_closed (self)
 
None open_cover (self, **Any kwargs)
 
None set_cover_position (self, **Any kwargs)
 
None stop_cover (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.ads.entity.AdsEntity
None __init__ (self, AdsHub ads_hub, str name, str ads_var)
 
None async_initialize_device (self, str ads_var, type plctype, str state_key=STATE_KEY_STATE, int|None factor=None)
 
- 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)
 
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_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)
 
None async_toggle (self, **Any kwargs)
 
None async_toggle_tilt (self, **Any kwargs)
 
None close_cover_tilt (self, **Any kwargs)
 
int|None current_cover_tilt_position (self)
 
CoverDeviceClass|None device_class (self)
 
bool|None is_closing (self)
 
bool|None is_opening (self)
 
None open_cover_tilt (self, **Any kwargs)
 
None set_cover_tilt_position (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop_cover_tilt (self, **Any kwargs)
 
CoverEntityFeature supported_features (self)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (self, **Any kwargs)
 

Private Attributes

 _ads_var_close
 
 _ads_var_open
 
 _ads_var_pos_set
 
 _ads_var_position
 
 _ads_var_stop
 
 _attr_device_class
 
 _attr_supported_features
 
 _attr_unique_id
 

Additional Inherited Members

- 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
 
- 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 ADS cover.

Definition at line 87 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ads.cover.AdsCover.__init__ (   self,
AdsHub  ads_hub,
str  ads_var_is_closed,
str | None  ads_var_position,
str | None  ads_var_pos_set,
str | None  ads_var_open,
str | None  ads_var_close,
str | None  ads_var_stop,
str  name,
CoverDeviceClass | None  device_class 
)
Initialize AdsCover entity.

Definition at line 90 of file cover.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.ads.cover.AdsCover.async_added_to_hass (   self)
Register device notification.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 127 of file cover.py.

◆ available()

bool homeassistant.components.ads.cover.AdsCover.available (   self)
Return False if state has not been updated yet.

Reimplemented from homeassistant.components.ads.entity.AdsEntity.

Definition at line 179 of file cover.py.

◆ close_cover()

None homeassistant.components.ads.cover.AdsCover.close_cover (   self,
**Any  kwargs 
)
Move the cover down.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 171 of file cover.py.

◆ current_cover_position()

int homeassistant.components.ads.cover.AdsCover.current_cover_position (   self)
Return current position of cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 147 of file cover.py.

◆ is_closed()

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

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 138 of file cover.py.

◆ open_cover()

None homeassistant.components.ads.cover.AdsCover.open_cover (   self,
**Any  kwargs 
)
Move the cover up.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 164 of file cover.py.

◆ set_cover_position()

None homeassistant.components.ads.cover.AdsCover.set_cover_position (   self,
**Any  kwargs 
)
Set cover position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 156 of file cover.py.

◆ stop_cover()

None homeassistant.components.ads.cover.AdsCover.stop_cover (   self,
**Any  kwargs 
)
Fire the stop action.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 151 of file cover.py.

Member Data Documentation

◆ _ads_var_close

homeassistant.components.ads.cover.AdsCover._ads_var_close
private

Definition at line 116 of file cover.py.

◆ _ads_var_open

homeassistant.components.ads.cover.AdsCover._ads_var_open
private

Definition at line 115 of file cover.py.

◆ _ads_var_pos_set

homeassistant.components.ads.cover.AdsCover._ads_var_pos_set
private

Definition at line 114 of file cover.py.

◆ _ads_var_position

homeassistant.components.ads.cover.AdsCover._ads_var_position
private

Definition at line 113 of file cover.py.

◆ _ads_var_stop

homeassistant.components.ads.cover.AdsCover._ads_var_stop
private

Definition at line 117 of file cover.py.

◆ _attr_device_class

homeassistant.components.ads.cover.AdsCover._attr_device_class
private

Definition at line 118 of file cover.py.

◆ _attr_supported_features

homeassistant.components.ads.cover.AdsCover._attr_supported_features
private

Definition at line 119 of file cover.py.

◆ _attr_unique_id

homeassistant.components.ads.cover.AdsCover._attr_unique_id
private

Definition at line 106 of file cover.py.


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