Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
homeassistant.components.esphome.entity.EsphomeEntity Class Reference
Inheritance diagram for homeassistant.components.esphome.entity.EsphomeEntity:
[legend]
Collaboration diagram for homeassistant.components.esphome.entity.EsphomeEntity:
[legend]

Public Member Functions

None __init__ (self, RuntimeEntryData entry_data, str domain, EntityInfo entity_info, type[_StateT] state_type)
 
None async_added_to_hass (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, str] translation_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

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

Private Member Functions

None _on_device_update (self)
 
None _on_entry_data_changed (self)
 
None _on_state_update (self)
 
None _on_static_info_update (self, EntityInfo static_info)
 
None _update_state_from_entry_data (self)
 

Private Attributes

 _api_version
 
 _attr_available
 
 _attr_device_info
 
 _attr_entity_category
 
 _attr_entity_registry_enabled_default
 
 _attr_has_entity_name
 
 _attr_icon
 
 _attr_name
 
 _attr_unique_id
 
 _client
 
 _device_info
 
 _entry_data
 
 _has_state
 
 _key
 
 _state
 
 _state_type
 
 _states
 
 _static_info
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Define a base esphome entity.

Definition at line 188 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.esphome.entity.EsphomeEntity.__init__ (   self,
RuntimeEntryData  entry_data,
str  domain,
EntityInfo  entity_info,
type[_StateT]  state_type 
) 
Initialize.

Definition at line 196 of file entity.py.

Member Function Documentation

◆ _on_device_update()

None homeassistant.components.esphome.entity.EsphomeEntity._on_device_update (   self)
private 
Call when device updates or entry data changes.

Reimplemented in homeassistant.components.esphome.camera.EsphomeCamera, and homeassistant.components.esphome.button.EsphomeButton.

Definition at line 310 of file entity.py.

◆ _on_entry_data_changed()

None homeassistant.components.esphome.entity.EsphomeEntity._on_entry_data_changed (   self)
private

Definition at line 298 of file entity.py.

◆ _on_state_update()

None homeassistant.components.esphome.entity.EsphomeEntity._on_state_update (   self)
private 
Call when state changed.

Behavior can be changed in child classes

Reimplemented in homeassistant.components.esphome.event.EsphomeEvent, and homeassistant.components.esphome.camera.EsphomeCamera.

Definition at line 289 of file entity.py.

◆ _on_static_info_update()

None homeassistant.components.esphome.entity.EsphomeEntity._on_static_info_update (   self,
EntityInfo  static_info 
)
private 
Save the static info for this entity when it changes.

This method can be overridden in child classes to know
when the static info changes.

Reimplemented in homeassistant.components.esphome.valve.EsphomeValve, homeassistant.components.esphome.update.ESPHomeUpdateEntity, homeassistant.components.esphome.text.EsphomeText, homeassistant.components.esphome.switch.EsphomeSwitch, homeassistant.components.esphome.sensor.EsphomeTextSensor, homeassistant.components.esphome.sensor.EsphomeSensor, homeassistant.components.esphome.select.EsphomeSelect, homeassistant.components.esphome.number.EsphomeNumber, homeassistant.components.esphome.media_player.EsphomeMediaPlayer, homeassistant.components.esphome.lock.EsphomeLock, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.esphome.fan.EsphomeFan, homeassistant.components.esphome.event.EsphomeEvent, homeassistant.components.esphome.cover.EsphomeCover, homeassistant.components.esphome.climate.EsphomeClimateEntity, homeassistant.components.esphome.button.EsphomeButton, homeassistant.components.esphome.binary_sensor.EsphomeBinarySensor, and homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.

Definition at line 257 of file entity.py.

◆ _update_state_from_entry_data()

None homeassistant.components.esphome.entity.EsphomeEntity._update_state_from_entry_data (   self)
private 
Update state from entry data.

Definition at line 281 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.esphome.entity.EsphomeEntity.async_added_to_hass (   self) 
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 236 of file entity.py.

Member Data Documentation

◆ _api_version

homeassistant.components.esphome.entity.EsphomeEntity._api_version
private

Definition at line 300 of file entity.py.

◆ _attr_available

homeassistant.components.esphome.entity.EsphomeEntity._attr_available
private

Definition at line 305 of file entity.py.

◆ _attr_device_info

homeassistant.components.esphome.entity.EsphomeEntity._attr_device_info
private

Definition at line 213 of file entity.py.

◆ _attr_entity_category

homeassistant.components.esphome.entity.EsphomeEntity._attr_entity_category
private

Definition at line 272 of file entity.py.

◆ _attr_entity_registry_enabled_default

homeassistant.components.esphome.entity.EsphomeEntity._attr_entity_registry_enabled_default
private

Definition at line 269 of file entity.py.

◆ _attr_has_entity_name

homeassistant.components.esphome.entity.EsphomeEntity._attr_has_entity_name
private

Definition at line 233 of file entity.py.

◆ _attr_icon

homeassistant.components.esphome.entity.EsphomeEntity._attr_icon
private

Definition at line 276 of file entity.py.

◆ _attr_name

homeassistant.components.esphome.entity.EsphomeEntity._attr_name
private

Definition at line 270 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.esphome.entity.EsphomeEntity._attr_should_poll = False
staticprivate

Definition at line 191 of file entity.py.

◆ _attr_unique_id

homeassistant.components.esphome.entity.EsphomeEntity._attr_unique_id
private

Definition at line 268 of file entity.py.

◆ _client

homeassistant.components.esphome.entity.EsphomeEntity._client
private

Definition at line 301 of file entity.py.

◆ _device_info

homeassistant.components.esphome.entity.EsphomeEntity._device_info
private

Definition at line 208 of file entity.py.

◆ _entry_data

homeassistant.components.esphome.entity.EsphomeEntity._entry_data
private

Definition at line 204 of file entity.py.

◆ _has_state

homeassistant.components.esphome.entity.EsphomeEntity._has_state
private

Definition at line 286 of file entity.py.

◆ _key

homeassistant.components.esphome.entity.EsphomeEntity._key
private

Definition at line 210 of file entity.py.

◆ _state

homeassistant.components.esphome.entity.EsphomeEntity._state
private

Definition at line 285 of file entity.py.

◆ _state_type

homeassistant.components.esphome.entity.EsphomeEntity._state_type
private

Definition at line 211 of file entity.py.

◆ _states

homeassistant.components.esphome.entity.EsphomeEntity._states
private

Definition at line 205 of file entity.py.

◆ _static_info

homeassistant.components.esphome.entity.EsphomeEntity._static_info
private

Definition at line 267 of file entity.py.

◆ entity_id

homeassistant.components.esphome.entity.EsphomeEntity.entity_id

Definition at line 234 of file entity.py.

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