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

Public Member Functions

def __init__ (self, element, unique_id, upb)
 
def async_added_to_hass (self)
 
def available (self)
 
def extra_state_attributes (self)
 
def 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)
 
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

def _element_callback (self, element, changeset)
 
def _element_changed (self, element, changeset)
 

Private Attributes

 _element
 
 _unique_id
 
 _upb
 

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

Base class for all UPB entities.

Definition at line 10 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.upb.entity.UpbEntity.__init__ (   self,
  element,
  unique_id,
  upb 
)
Initialize the base of all UPB devices.

Reimplemented in homeassistant.components.upb.scene.UpbLink, and homeassistant.components.upb.light.UpbLight.

Definition at line 15 of file entity.py.

Member Function Documentation

◆ _element_callback()

def homeassistant.components.upb.entity.UpbEntity._element_callback (   self,
  element,
  changeset 
)
private
Handle callback from an UPB element that has changed.

Definition at line 41 of file entity.py.

◆ _element_changed()

def homeassistant.components.upb.entity.UpbEntity._element_changed (   self,
  element,
  changeset 
)
private

Reimplemented in homeassistant.components.upb.light.UpbLight.

Definition at line 37 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.upb.entity.UpbEntity.async_added_to_hass (   self)
Register callback for UPB changes and update entity state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 46 of file entity.py.

◆ available()

def homeassistant.components.upb.entity.UpbEntity.available (   self)
Is the entity available to be updated.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 33 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.upb.entity.UpbEntity.extra_state_attributes (   self)
Return the default attributes of the element.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 28 of file entity.py.

◆ unique_id()

def homeassistant.components.upb.entity.UpbEntity.unique_id (   self)
Return unique id of the element.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 23 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.upb.entity.UpbEntity._attr_should_poll = False
staticprivate

Definition at line 13 of file entity.py.

◆ _element

homeassistant.components.upb.entity.UpbEntity._element
private

Definition at line 18 of file entity.py.

◆ _unique_id

homeassistant.components.upb.entity.UpbEntity._unique_id
private

Definition at line 20 of file entity.py.

◆ _upb

homeassistant.components.upb.entity.UpbEntity._upb
private

Definition at line 17 of file entity.py.


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