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

Public Member Functions

None __init__ (self, dict[str, Any] device, LutronCasetaData data)
 
def async_added_to_hass (self)
 
def device_id (self)
 
def extra_state_attributes (self)
 
int|None serial (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_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)
 
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

str|int _handle_none_serial (self, str|int|None serial)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _bridge_device
 
 _bridge_unique_id
 
 _device
 
 _smartbridge
 

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

Common base class for all Lutron Caseta devices.

Definition at line 19 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.__init__ (   self,
dict[str, Any]  device,
LutronCasetaData  data 
)
Set up the base class.

[:param]device the device metadata
[:param]bridge the smartbridge object
[:param]bridge_device a dict with the details of the bridge

Reimplemented in homeassistant.components.lutron_caseta.light.LutronCasetaLight.

Definition at line 24 of file entity.py.

Member Function Documentation

◆ _handle_none_serial()

str | int homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._handle_none_serial (   self,
str | int | None  serial 
)
private
Handle None serial returned by RA3 and QSX processors.

Definition at line 70 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor.

Definition at line 66 of file entity.py.

◆ device_id()

def homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.device_id (   self)
Return the device ID used for calling pylutron_caseta.

Reimplemented in homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor.

Definition at line 77 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor.

Definition at line 92 of file entity.py.

◆ serial()

int | None homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.serial (   self)
Return the serial number of the device.

Reimplemented in homeassistant.components.lutron_caseta.button.LutronCasetaButton.

Definition at line 82 of file entity.py.

◆ unique_id()

str homeassistant.components.lutron_caseta.entity.LutronCasetaEntity.unique_id (   self)
Return the unique ID of the device (serial).

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor.

Definition at line 87 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._attr_device_info
private

Definition at line 64 of file entity.py.

◆ _attr_name

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._attr_name
private

Definition at line 43 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._attr_should_poll = False
staticprivate

Definition at line 22 of file entity.py.

◆ _bridge_device

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._bridge_device
private

Definition at line 33 of file entity.py.

◆ _bridge_unique_id

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._bridge_unique_id
private

Definition at line 34 of file entity.py.

◆ _device

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._device
private

Definition at line 31 of file entity.py.

◆ _smartbridge

homeassistant.components.lutron_caseta.entity.LutronCasetaEntity._smartbridge
private

Definition at line 32 of file entity.py.


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