Public Member Functions
None	__init__ (self, HomeAssistant hass, ESPHomeConfigEntry entry, str host, str\|None password, APIClient cli, zeroconf.HaZeroconf zeroconf_instance, DomainData domain_data)

None	async_on_service_call (self, HomeassistantServiceCall service)

None	async_on_state_request (self, str entity_id, str\|None attribute=None)

None	async_on_state_subscription (self, str entity_id, str\|None attribute=None)

None	async_start (self)

None	on_connect (self)

None	on_connect_error (self, Exception err)

None	on_disconnect (self, bool expected_disconnect)

None	on_stop (self, Event event)

str	services_issue (self)

Public Attributes
	cli

	device_id

	domain_data

	entry

	entry_data

	hass

	host

	password

	reconnect_logic

	zeroconf_instance

Private Member Functions
None	_async_handle_logging_changed (self, Event _event)

None	_on_connnect (self)

None	_send_home_assistant_state (self, str entity_id, str\|None attribute, State\|None state)

None	_send_home_assistant_state_event (self, str\|None attribute, Event[EventStateChangedData] event)

Static Private Attributes
tuple	__slots__

Detailed Description

Class to manage an ESPHome connection.

Definition at line 133 of file manager.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.esphome.manager.ESPHomeManager.__init__	(		self,
		HomeAssistant	hass,
		ESPHomeConfigEntry	entry,
		str	host,
		str \| None	password,
		APIClient	cli,
		zeroconf.HaZeroconf	zeroconf_instance,
		DomainData	domain_data
	)

Initialize the esphome manager.

Definition at line 149 of file manager.py.

Member Function Documentation

◆ _async_handle_logging_changed()

None homeassistant.components.esphome.manager.ESPHomeManager._async_handle_logging_changed	(		self,
		Event	_event
	)

private

Handle when the logging level changes.

Definition at line 499 of file manager.py.

◆ _on_connnect()

None homeassistant.components.esphome.manager.ESPHomeManager._on_connnect ( self )

private

Subscribe to states and list entities on successful API login.

Definition at line 342 of file manager.py.

◆ _send_home_assistant_state()

None homeassistant.components.esphome.manager.ESPHomeManager._send_home_assistant_state	(		self,
		str	entity_id,
		str \| None	attribute,
		State \| None	state
	)

private

Forward Home Assistant states to ESPHome.

Definition at line 262 of file manager.py.

◆ _send_home_assistant_state_event()

None homeassistant.components.esphome.manager.ESPHomeManager._send_home_assistant_state_event	(		self,
		str \| None	attribute,
		Event[EventStateChangedData]	event
	)

private

Forward Home Assistant states updates to ESPHome.

Definition at line 281 of file manager.py.

◆ async_on_service_call()

None homeassistant.components.esphome.manager.ESPHomeManager.async_on_service_call	(		self,
		HomeassistantServiceCall	service
	)

Call service when user automation in ESPHome config is triggered.

Definition at line 181 of file manager.py.

◆ async_on_state_request()

None homeassistant.components.esphome.manager.ESPHomeManager.async_on_state_request	(		self,
		str	entity_id,
		str \| None	attribute = `None`
	)

Forward state for requested entity.

Definition at line 323 of file manager.py.

◆ async_on_state_subscription()

None homeassistant.components.esphome.manager.ESPHomeManager.async_on_state_subscription	(		self,
		str	entity_id,
		str \| None	attribute = `None`
	)

Subscribe and forward states for requested entities.

Definition at line 305 of file manager.py.

◆ async_start()

None homeassistant.components.esphome.manager.ESPHomeManager.async_start ( self )

Start the esphome connection manager.

Definition at line 503 of file manager.py.

◆ on_connect()

None homeassistant.components.esphome.manager.ESPHomeManager.on_connect ( self )

Subscribe to states and list entities on successful API login.

Definition at line 331 of file manager.py.

◆ on_connect_error()

None homeassistant.components.esphome.manager.ESPHomeManager.on_connect_error	(		self,
		Exception	err
	)

Start reauth flow if appropriate connect error type.

Definition at line 486 of file manager.py.

◆ on_disconnect()

None homeassistant.components.esphome.manager.ESPHomeManager.on_disconnect	(		self,
		bool	expected_disconnect
	)

Run disconnect callbacks on API disconnect.

Definition at line 451 of file manager.py.

◆ on_stop()

None homeassistant.components.esphome.manager.ESPHomeManager.on_stop	(		self,
		Event	event
	)

Cleanup the socket client on HA close.

Definition at line 171 of file manager.py.

◆ services_issue()

str homeassistant.components.esphome.manager.ESPHomeManager.services_issue ( self )

Return the services issue name for this entry.

Definition at line 176 of file manager.py.

Member Data Documentation

◆ slots

tuple homeassistant.components.esphome.manager.ESPHomeManager.__slots__

staticprivate

Initial value:

=  (
        "hass",
        "host",
        "password",
        "entry",
        "cli",
        "device_id",
        "domain_data",
        "reconnect_logic",
        "zeroconf_instance",
        "entry_data",
    )

Definition at line 136 of file manager.py.

◆ cli

homeassistant.components.esphome.manager.ESPHomeManager.cli

Definition at line 164 of file manager.py.

◆ device_id

homeassistant.components.esphome.manager.ESPHomeManager.device_id

Definition at line 416 of file manager.py.

◆ domain_data

homeassistant.components.esphome.manager.ESPHomeManager.domain_data

Definition at line 166 of file manager.py.

◆ entry

homeassistant.components.esphome.manager.ESPHomeManager.entry

Definition at line 163 of file manager.py.

◆ entry_data

homeassistant.components.esphome.manager.ESPHomeManager.entry_data

Definition at line 169 of file manager.py.

◆ hass

homeassistant.components.esphome.manager.ESPHomeManager.hass

Definition at line 160 of file manager.py.

◆ host

homeassistant.components.esphome.manager.ESPHomeManager.host

Definition at line 161 of file manager.py.

◆ password

homeassistant.components.esphome.manager.ESPHomeManager.password

Definition at line 162 of file manager.py.

◆ reconnect_logic

homeassistant.components.esphome.manager.ESPHomeManager.reconnect_logic

Definition at line 520 of file manager.py.

◆ zeroconf_instance

homeassistant.components.esphome.manager.ESPHomeManager.zeroconf_instance

Definition at line 168 of file manager.py.

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

core/homeassistant/components/esphome/manager.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_handle_logging_changed()

◆ _on_connnect()

◆ _send_home_assistant_state()

◆ _send_home_assistant_state_event()

◆ async_on_service_call()

◆ async_on_state_request()

◆ async_on_state_subscription()

◆ async_start()

◆ on_connect()

◆ on_connect_error()

◆ on_disconnect()

◆ on_stop()

◆ services_issue()

Member Data Documentation

◆ __slots__

◆ cli

◆ device_id

◆ domain_data

◆ entry

◆ entry_data

◆ hass

◆ host

◆ password

◆ reconnect_logic

◆ zeroconf_instance

◆ init()

◆ slots