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

Public Member Functions

None __init__ (self, ConfigType config, ConfigEntry config_entry)
 
None async_added_to_hass (self)
 
None async_will_remove_from_hass (self)
 
DeviceInfo|None device_info (self)
 
None input_received (self, InputType input_obj)
 
str name (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)
 
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_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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)
 
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)
 
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)
 

Public Attributes

 config
 
 config_entry
 
 device_connection
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _unregister_for_inputs
 

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
 

Detailed Description

Parent class for all entities associated with the LCN component.

Definition at line 22 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ async_added_to_hass()

◆ async_will_remove_from_hass()

◆ device_info()

DeviceInfo | None homeassistant.components.lcn.entity.LcnEntity.device_info (   self)
Return device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 48 of file entity.py.

◆ input_received()

◆ name()

str homeassistant.components.lcn.entity.LcnEntity.name (   self)
Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 85 of file entity.py.

◆ unique_id()

str homeassistant.components.lcn.entity.LcnEntity.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 41 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.lcn.entity.LcnEntity._attr_should_poll = False
staticprivate

Definition at line 25 of file entity.py.

◆ _unregister_for_inputs

homeassistant.components.lcn.entity.LcnEntity._unregister_for_inputs
private

Definition at line 75 of file entity.py.

◆ config

homeassistant.components.lcn.entity.LcnEntity.config
Initialize the LCN device.

Definition at line 34 of file entity.py.

◆ config_entry

homeassistant.components.lcn.entity.LcnEntity.config_entry

Definition at line 35 of file entity.py.

◆ device_connection

homeassistant.components.lcn.entity.LcnEntity.device_connection
Run when entity about to be added to hass.

Definition at line 71 of file entity.py.


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