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

Public Member Functions

def __init__ (self, client, device_id)
 
def assumed_state (self)
 
def async_added_to_hass (self)
 
def available (self)
 
def device (self)
 
def device_id (self)
 
DeviceInfo device_info (self)
 
def extra_state_attributes (self)
 
str unique_id (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)
 
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)
 
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)
 
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 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 Member Functions

def _battery_level (self)
 
def _last_updated (self)
 
def _state (self)
 

Private Attributes

 _client
 
 _id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
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

Base class for all Telldus Live entities.

Definition at line 25 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.__init__ (   self,
  client,
  device_id 
)

Member Function Documentation

◆ _battery_level()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity._battery_level (   self)
private
Return the battery level of a device.

Definition at line 81 of file entity.py.

◆ _last_updated()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity._last_updated (   self)
private
Return the last update of a device.

Definition at line 92 of file entity.py.

◆ _state()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity._state (   self)
private
Return the state of the device.

Definition at line 56 of file entity.py.

◆ assumed_state()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.assumed_state (   self)
Return true if unable to access real state of entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 61 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 36 of file entity.py.

◆ available()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.available (   self)
Return true if device is not offline.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 66 of file entity.py.

◆ device()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.device (   self)
Return the representation of the device.

Definition at line 51 of file entity.py.

◆ device_id()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.device_id (   self)
Return the id of the device.

Reimplemented in homeassistant.components.tellduslive.sensor.TelldusLiveSensor.

Definition at line 46 of file entity.py.

◆ device_info()

DeviceInfo homeassistant.components.tellduslive.entity.TelldusLiveEntity.device_info (   self)
Return device info.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 106 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.tellduslive.entity.TelldusLiveEntity.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 71 of file entity.py.

◆ unique_id()

str homeassistant.components.tellduslive.entity.TelldusLiveEntity.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.tellduslive.sensor.TelldusLiveSensor.

Definition at line 101 of file entity.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.tellduslive.entity.TelldusLiveEntity._attr_has_entity_name = True
staticprivate

Definition at line 29 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.tellduslive.entity.TelldusLiveEntity._attr_should_poll = False
staticprivate

Definition at line 28 of file entity.py.

◆ _client

homeassistant.components.tellduslive.entity.TelldusLiveEntity._client
private

Definition at line 34 of file entity.py.

◆ _id

homeassistant.components.tellduslive.entity.TelldusLiveEntity._id
private

Definition at line 33 of file entity.py.


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