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

Public Member Functions

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)
 
bool available (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_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)
 
dict[str, Any]|None capability_attributes (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)
 
StateType state (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)
 

Private Attributes

 _ads_hub
 
 _ads_var
 
 _attr_name
 
 _attr_unique_id
 
 _event
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of ADS entity.

Definition at line 16 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ads.entity.AdsEntity.__init__ (   self,
AdsHub  ads_hub,
str  name,
str  ads_var 
)
Initialize ADS binary sensor.

Definition at line 21 of file entity.py.

Member Function Documentation

◆ async_initialize_device()

None homeassistant.components.ads.entity.AdsEntity.async_initialize_device (   self,
str  ads_var,
type  plctype,
str   state_key = STATE_KEY_STATE,
int | None   factor = None 
)
Register device notification.

Definition at line 31 of file entity.py.

◆ available()

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

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.ads.cover.AdsCover.

Definition at line 68 of file entity.py.

Member Data Documentation

◆ _ads_hub

homeassistant.components.ads.entity.AdsEntity._ads_hub
private

Definition at line 25 of file entity.py.

◆ _ads_var

homeassistant.components.ads.entity.AdsEntity._ads_var
private

Definition at line 26 of file entity.py.

◆ _attr_name

homeassistant.components.ads.entity.AdsEntity._attr_name
private

Definition at line 29 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.ads.entity.AdsEntity._attr_should_poll = False
staticprivate

Definition at line 19 of file entity.py.

◆ _attr_unique_id

homeassistant.components.ads.entity.AdsEntity._attr_unique_id
private

Definition at line 28 of file entity.py.

◆ _event

homeassistant.components.ads.entity.AdsEntity._event
private

Definition at line 56 of file entity.py.


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