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

Public Member Functions

def __hash__ (self)
 
def __init__ (self, device, group)
 
def address (self)
 
def async_added_to_hass (self)
 
def async_entity_update (self, name, address, value, group)
 
def async_will_remove_from_hass (self)
 
DeviceInfo device_info (self)
 
def extra_state_attributes (self)
 
def get_device_property (self, str name)
 
def group (self)
 
def 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)
 
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)
 

Private Member Functions

def _async_add_default_links (self)
 
def _async_read_aldb (self, reload)
 
def _get_label (self)
 
def _print_aldb (self)
 

Private Attributes

 _insteon_device
 
 _insteon_device_group
 

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

INSTEON abstract base entity.

Definition at line 30 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.insteon.entity.InsteonEntity.__init__ (   self,
  device,
  group 
)
Initialize the INSTEON binary sensor.

Reimplemented in homeassistant.components.insteon.binary_sensor.InsteonBinarySensorEntity.

Definition at line 35 of file entity.py.

Member Function Documentation

◆ __hash__()

def homeassistant.components.insteon.entity.InsteonEntity.__hash__ (   self)
Return the hash of the Insteon Entity.

Definition at line 40 of file entity.py.

◆ _async_add_default_links()

def homeassistant.components.insteon.entity.InsteonEntity._async_add_default_links (   self)
private
Add default links between the device and the modem.

Definition at line 176 of file entity.py.

◆ _async_read_aldb()

def homeassistant.components.insteon.entity.InsteonEntity._async_read_aldb (   self,
  reload 
)
private
Call device load process and print to log.

Definition at line 150 of file entity.py.

◆ _get_label()

def homeassistant.components.insteon.entity.InsteonEntity._get_label (   self)
private
Get the device label for grouped devices.

Definition at line 166 of file entity.py.

◆ _print_aldb()

def homeassistant.components.insteon.entity.InsteonEntity._print_aldb (   self)
private
Print the device ALDB to the log file.

Definition at line 156 of file entity.py.

◆ address()

def homeassistant.components.insteon.entity.InsteonEntity.address (   self)
Return the address of the node.

Definition at line 45 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.insteon.entity.InsteonEntity.async_added_to_hass (   self)
Register INSTEON update events.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.insteon.climate.InsteonClimateEntity.

Definition at line 112 of file entity.py.

◆ async_entity_update()

def homeassistant.components.insteon.entity.InsteonEntity.async_entity_update (   self,
  name,
  address,
  value,
  group 
)
Receive notification from transport that new data exists.

Definition at line 102 of file entity.py.

◆ async_will_remove_from_hass()

def homeassistant.components.insteon.entity.InsteonEntity.async_will_remove_from_hass (   self)
Unsubscribe to INSTEON update events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 140 of file entity.py.

◆ device_info()

DeviceInfo homeassistant.components.insteon.entity.InsteonEntity.device_info (   self)
Return device information.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 83 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.insteon.entity.InsteonEntity.extra_state_attributes (   self)
Provide attributes for display on device card.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.insteon.climate.InsteonClimateEntity.

Definition at line 75 of file entity.py.

◆ get_device_property()

def homeassistant.components.insteon.entity.InsteonEntity.get_device_property (   self,
str  name 
)
Get a single Insteon device property value (raw).

Definition at line 160 of file entity.py.

◆ group()

def homeassistant.components.insteon.entity.InsteonEntity.group (   self)
Return the INSTEON group that the entity responds to.

Definition at line 50 of file entity.py.

◆ name()

def homeassistant.components.insteon.entity.InsteonEntity.name (   self)
Return the name of the node (used for Entity_ID).

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 64 of file entity.py.

◆ unique_id()

str homeassistant.components.insteon.entity.InsteonEntity.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 55 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.insteon.entity.InsteonEntity._attr_should_poll = False
staticprivate

Definition at line 33 of file entity.py.

◆ _insteon_device

homeassistant.components.insteon.entity.InsteonEntity._insteon_device
private

Definition at line 38 of file entity.py.

◆ _insteon_device_group

homeassistant.components.insteon.entity.InsteonEntity._insteon_device_group
private

Definition at line 37 of file entity.py.


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