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

Public Member Functions

None __init__ (self, str area_name, LutronEntity lutron_device, Lutron controller)
 
None async_added_to_hass (self)
 
str unique_id (self)
 
None update (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_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)
 
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 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

None _request_state (self)
 
None _update_attrs (self)
 
None _update_callback (self, LutronEntity _device, None _context, LutronEvent _event, dict _params)
 

Private Attributes

 _area_name
 
 _controller
 
 _lutron_device
 

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 Lutron entities.

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lutron.entity.LutronBaseEntity.__init__ (   self,
str  area_name,
LutronEntity  lutron_device,
Lutron   controller 
)
Initialize the device.

Reimplemented in homeassistant.components.lutron.entity.LutronDevice.

Definition at line 18 of file entity.py.

Member Function Documentation

◆ _request_state()

None homeassistant.components.lutron.entity.LutronBaseEntity._request_state (   self)
private

◆ _update_attrs()

◆ _update_callback()

None homeassistant.components.lutron.entity.LutronBaseEntity._update_callback (   self,
LutronEntity  _device,
None  _context,
LutronEvent  _event,
dict   _params 
)
private
Run when invoked by pylutron when the device state changes.

Definition at line 36 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.lutron.entity.LutronBaseEntity.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.lutron.event.LutronEventEntity.

Definition at line 26 of file entity.py.

◆ unique_id()

str homeassistant.components.lutron.entity.LutronBaseEntity.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 44 of file entity.py.

◆ update()

None homeassistant.components.lutron.entity.LutronBaseEntity.update (   self)
Update the entity's state.

Definition at line 51 of file entity.py.

Member Data Documentation

◆ _area_name

homeassistant.components.lutron.entity.LutronBaseEntity._area_name
private

Definition at line 24 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.lutron.entity.LutronBaseEntity._attr_has_entity_name = True
staticprivate

Definition at line 16 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.lutron.entity.LutronBaseEntity._attr_should_poll = False
staticprivate

Definition at line 15 of file entity.py.

◆ _controller

homeassistant.components.lutron.entity.LutronBaseEntity._controller
private

Definition at line 23 of file entity.py.

◆ _lutron_device

homeassistant.components.lutron.entity.LutronBaseEntity._lutron_device
private

Definition at line 22 of file entity.py.


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