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

Public Member Functions

None __init__ (self, list[int] dev_id)
 
def async_added_to_hass (self)
 
def send_command (self, data, optional, packet_type)
 
def value_changed (self, packet)
 
- 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 unique_id (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

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

Private Member Functions

def _message_received_callback (self, packet)
 

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 EnOcean component.

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.enocean.entity.EnOceanEntity.__init__ (   self,
list[int]  dev_id 
)
Initialize the device.

Definition at line 15 of file entity.py.

Member Function Documentation

◆ _message_received_callback()

def homeassistant.components.enocean.entity.EnOceanEntity._message_received_callback (   self,
  packet 
)
private
Handle incoming packets.

Definition at line 27 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.enocean.entity.EnOceanEntity.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.enocean.sensor.EnOceanSensor.

Definition at line 19 of file entity.py.

◆ send_command()

def homeassistant.components.enocean.entity.EnOceanEntity.send_command (   self,
  data,
  optional,
  packet_type 
)
Send a command via the EnOcean dongle.

Definition at line 36 of file entity.py.

◆ value_changed()

Member Data Documentation

◆ dev_id

homeassistant.components.enocean.entity.EnOceanEntity.dev_id

Definition at line 17 of file entity.py.


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