homeassistant.components.esphome.entry_data.RuntimeEntryData Class Reference

Public Member Functions
None	async_assist_satellite_config_updated (self, AssistSatelliteConfiguration config)
None	async_assist_satellite_set_wake_word (self, str wake_word_id)
None	async_cleanup (self)
tuple[list[EntityInfo], list[UserService]]	async_load_from_store (self)
None	async_on_connect (self, DeviceInfo device_info, APIVersion api_version)
None	async_on_disconnect (self)
CALLBACK_TYPE	async_register_assist_satellite_config_updated_callback (self, Callable[[AssistSatelliteConfiguration], None] callback_)
CALLBACK_TYPE	async_register_assist_satellite_set_wake_word_callback (self, Callable[[str], None] callback_)
CALLBACK_TYPE	async_register_key_static_info_updated_callback (self, EntityInfo static_info, Callable[[EntityInfo], None] callback_)
CALLBACK_TYPE	async_register_static_info_callback (self, type[EntityInfo] entity_info_type, Callable[[list[EntityInfo]], None] callback_)
None	async_remove_entities (self, HomeAssistant hass, Iterable[EntityInfo] static_infos, str mac)
None	async_save_to_store (self)
None	async_set_assist_pipeline_state (self, bool state)
CALLBACK_TYPE	async_subscribe_assist_pipeline_update (self, CALLBACK_TYPE update_callback)
CALLBACK_TYPE	async_subscribe_device_updated (self, CALLBACK_TYPE callback_)
CALLBACK_TYPE	async_subscribe_state_update (self, type[EntityState] state_type, int state_key, CALLBACK_TYPE entity_callback)
CALLBACK_TYPE	async_subscribe_static_info_updated (self, Callable[[list[EntityInfo]], None] callback_)
None	async_update_device_state (self)
None	async_update_entity_infos (self, Iterable[EntityInfo] static_infos)
None	async_update_listener (self, HomeAssistant hass, ESPHomeConfigEntry entry)
None	async_update_state (self, EntityState state)
None	async_update_static_infos (self, HomeAssistant hass, ESPHomeConfigEntry entry, list[EntityInfo] infos, str mac)
str	friendly_name (self)
str	name (self)

Public Attributes
	api_version
	assist_pipeline_state
	available
	device_info
	disconnect_callbacks
	expected_disconnect
	original_options

Static Public Attributes
	APIVersion
	bool
	default_factory
	Lock
	None

Private Member Functions
None	_async_unsubscribe_assist_pipeline_update (self, CALLBACK_TYPE update_callback)
None	_async_unsubscribe_device_update (self, CALLBACK_TYPE callback_)
None	_async_unsubscribe_register_static_info (self, list[Callable[[list[EntityInfo]], None]] callbacks, Callable[[list[EntityInfo]], None] callback_)
None	_async_unsubscribe_state_update (self, tuple[type[EntityState], int] subscription_key)
None	_async_unsubscribe_static_info_updated (self, Callable[[list[EntityInfo]], None] callback_)
None	_async_unsubscribe_static_key_info_updated (self, list[Callable[[EntityInfo], None]] callbacks, Callable[[EntityInfo], None] callback_)
None	_ensure_platforms_loaded (self, HomeAssistant hass, ESPHomeConfigEntry entry, set[Platform] platforms)

Private Attributes
	_pending_storage
	_storage_contents

Detailed Description

Store runtime data for esphome config entries.

Definition at line 110 of file entry_data.py.

Member Function Documentation

_async_unsubscribe_assist_pipeline_update()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_assist_pipeline_update (   self, CALLBACK_TYPE   update_callback  )

private

Unsubscribe to assist pipeline updates.

Definition at line 238 of file entry_data.py.

_async_unsubscribe_device_update()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_device_update (   self, CALLBACK_TYPE  callback_  )

private

Unsubscribe to device updates.

Definition at line 339 of file entry_data.py.

_async_unsubscribe_register_static_info()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_register_static_info (   self, list[Callable[[list[EntityInfo]], None]]  callbacks, Callable[[list[EntityInfo]], None]  callback_  )

private

Unsubscribe to when static info is registered.

Definition at line 191 of file entry_data.py.

_async_unsubscribe_state_update()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_state_update (   self, tuple[type[EntityState], int]   subscription_key  )

private

Unsubscribe to state updates.

Definition at line 371 of file entry_data.py.

_async_unsubscribe_static_info_updated()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_static_info_updated (   self, Callable[[list[EntityInfo]], None]   callback_  )

private

Unsubscribe to static info updates.

Definition at line 352 of file entry_data.py.

_async_unsubscribe_static_key_info_updated()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._async_unsubscribe_static_key_info_updated (   self, list[Callable[[EntityInfo], None]]  callbacks, Callable[[EntityInfo], None]  callback_  )

private

Unsubscribe to when static info is updated .

Definition at line 214 of file entry_data.py.

_ensure_platforms_loaded()

None homeassistant.components.esphome.entry_data.RuntimeEntryData._ensure_platforms_loaded (   self, HomeAssistant  hass, ESPHomeConfigEntry  entry, set[Platform]  platforms  )

private

Definition at line 265 of file entry_data.py.

async_assist_satellite_config_updated()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_assist_satellite_config_updated	(		self,
		AssistSatelliteConfiguration	config
	)

Notify listeners that the Assist satellite configuration has been updated.

Definition at line 525 of file entry_data.py.

async_assist_satellite_set_wake_word()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_assist_satellite_set_wake_word	(		self,
		str	wake_word_id
	)

Notify listeners that the Assist satellite wake word has been set.

Definition at line 542 of file entry_data.py.

async_cleanup()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_cleanup

(

self

)

Cleanup the entry data when disconnected or unloading.

Definition at line 464 of file entry_data.py.

async_load_from_store()

tuple[list[EntityInfo], list[UserService]] homeassistant.components.esphome.entry_data.RuntimeEntryData.async_load_from_store

(

self

)

Load the retained data from store and return de-serialized data.

Definition at line 415 of file entry_data.py.

async_on_connect()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_on_connect	(		self,
		DeviceInfo	device_info,
		APIVersion	api_version
	)

Call when the entry has been connected.

Definition at line 498 of file entry_data.py.

async_on_disconnect()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_on_disconnect

(

self

)

Call when the entry has been disconnected.

Safe to call multiple times.

Definition at line 480 of file entry_data.py.

async_register_assist_satellite_config_updated_callback()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_register_assist_satellite_config_updated_callback	(		self,
		Callable[[AssistSatelliteConfiguration], None]	callback_
	)

Register to receive callbacks when the Assist satellite's configuration is updated.

Definition at line 516 of file entry_data.py.

async_register_assist_satellite_set_wake_word_callback()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_register_assist_satellite_set_wake_word_callback	(		self,
		Callable[[str], None]	callback_
	)

Register to receive callbacks when the Assist satellite's wake word is set.

Definition at line 533 of file entry_data.py.

async_register_key_static_info_updated_callback()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_register_key_static_info_updated_callback	(		self,
		EntityInfo	static_info,
		Callable[[EntityInfo], None]	callback_
	)

Register to receive callbacks when static info is updated for a specific key.

Definition at line 200 of file entry_data.py.

async_register_static_info_callback()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_register_static_info_callback	(		self,
		type[EntityInfo]	entity_info_type,
		Callable[[list[EntityInfo]], None]	callback_
	)

Register to receive callbacks when static info changes for an EntityInfo type.

Definition at line 178 of file entry_data.py.

async_remove_entities()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_remove_entities	(		self,
		HomeAssistant	hass,
		Iterable[EntityInfo]	static_infos,
		str	mac
	)

Schedule the removal of an entity.

Definition at line 245 of file entry_data.py.

async_save_to_store()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_save_to_store

(

self

)

Generate dynamic data to store and save it to the filesystem.

Definition at line 437 of file entry_data.py.

async_set_assist_pipeline_state()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_set_assist_pipeline_state	(		self,
		bool	state
	)

Set the assist pipeline state.

Definition at line 223 of file entry_data.py.

async_subscribe_assist_pipeline_update()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_subscribe_assist_pipeline_update	(		self,
		CALLBACK_TYPE	update_callback
	)

Subscribe to assist pipeline updates.

Definition at line 230 of file entry_data.py.

async_subscribe_device_updated()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_subscribe_device_updated	(		self,
		CALLBACK_TYPE	callback_
	)

Subscribe to state updates.

Definition at line 333 of file entry_data.py.

async_subscribe_state_update()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_subscribe_state_update	(		self,
		type[EntityState]	state_type,
		int	state_key,
		CALLBACK_TYPE	entity_callback
	)

Subscribe to state updates.

Definition at line 359 of file entry_data.py.

async_subscribe_static_info_updated()

CALLBACK_TYPE homeassistant.components.esphome.entry_data.RuntimeEntryData.async_subscribe_static_info_updated	(		self,
		Callable[[list[EntityInfo]], None]	callback_
	)

Subscribe to static info updates.

Definition at line 344 of file entry_data.py.

async_update_device_state()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_update_device_state

(

self

)

Distribute an update of a core device state like availability.

Definition at line 410 of file entry_data.py.

async_update_entity_infos()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_update_entity_infos	(		self,
		Iterable[EntityInfo]	static_infos
	)

Call static info updated callbacks.

Definition at line 258 of file entry_data.py.

async_update_listener()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_update_listener	(		self,
		HomeAssistant	hass,
		ESPHomeConfigEntry	entry
	)

Handle options update.

Definition at line 471 of file entry_data.py.

async_update_state()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_update_state	(		self,
		EntityState	state
	)

Distribute an update of state information to the target.

Definition at line 378 of file entry_data.py.

async_update_static_infos()

None homeassistant.components.esphome.entry_data.RuntimeEntryData.async_update_static_infos	(		self,
		HomeAssistant	hass,
		ESPHomeConfigEntry	entry,
		list[EntityInfo]	infos,
		str	mac
	)

Distribute an update of static infos to all platforms.

Definition at line 276 of file entry_data.py.

friendly_name()

str homeassistant.components.esphome.entry_data.RuntimeEntryData.friendly_name

(

self

)

Return the friendly name of the device.

Definition at line 170 of file entry_data.py.

name()

str homeassistant.components.esphome.entry_data.RuntimeEntryData.name

(

self

)

Return the name of the device.

Definition at line 164 of file entry_data.py.

Member Data Documentation

_pending_storage

homeassistant.components.esphome.entry_data.RuntimeEntryData._pending_storage

private

Definition at line 457 of file entry_data.py.

_storage_contents

homeassistant.components.esphome.entry_data.RuntimeEntryData._storage_contents

private

Definition at line 419 of file entry_data.py.

api_version

homeassistant.components.esphome.entry_data.RuntimeEntryData.api_version

Definition at line 422 of file entry_data.py.

APIVersion

homeassistant.components.esphome.entry_data.RuntimeEntryData.APIVersion

static

Definition at line 130 of file entry_data.py.

assist_pipeline_state

homeassistant.components.esphome.entry_data.RuntimeEntryData.assist_pipeline_state

Definition at line 225 of file entry_data.py.

available

homeassistant.components.esphome.entry_data.RuntimeEntryData.available

Definition at line 485 of file entry_data.py.

bool

homeassistant.components.esphome.entry_data.RuntimeEntryData.bool

static

Definition at line 126 of file entry_data.py.

default_factory

homeassistant.components.esphome.entry_data.RuntimeEntryData.default_factory

static

Definition at line 118 of file entry_data.py.

device_info

homeassistant.components.esphome.entry_data.RuntimeEntryData.device_info

Definition at line 421 of file entry_data.py.

disconnect_callbacks

homeassistant.components.esphome.entry_data.RuntimeEntryData.disconnect_callbacks

Definition at line 495 of file entry_data.py.

expected_disconnect

homeassistant.components.esphome.entry_data.RuntimeEntryData.expected_disconnect

Definition at line 513 of file entry_data.py.

Lock

homeassistant.components.esphome.entry_data.RuntimeEntryData.Lock

static

Definition at line 141 of file entry_data.py.

None

homeassistant.components.esphome.entry_data.RuntimeEntryData.None

static

Definition at line 128 of file entry_data.py.

original_options

homeassistant.components.esphome.entry_data.RuntimeEntryData.original_options

Definition at line 475 of file entry_data.py.

---

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

• core/homeassistant/components/esphome/entry_data.py