Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.esphome.manager Namespace Reference

Classes

class  ESPHomeManager
 
class  ServiceMetadata
 

Functions

None _async_check_firmware_version (HomeAssistant hass, EsphomeDeviceInfo device_info, APIVersion api_version)
 
None _async_check_using_api_password (HomeAssistant hass, EsphomeDeviceInfo device_info, bool has_password)
 
None _async_register_service (HomeAssistant hass, RuntimeEntryData entry_data, EsphomeDeviceInfo device_info, UserService service)
 
str _async_setup_device_registry (HomeAssistant hass, ESPHomeConfigEntry entry, RuntimeEntryData entry_data)
 
None _setup_services (HomeAssistant hass, RuntimeEntryData entry_data, list[UserService] services)
 
str build_service_name (EsphomeDeviceInfo device_info, UserService service)
 
RuntimeEntryData cleanup_instance (HomeAssistant hass, ESPHomeConfigEntry entry)
 
None execute_service (RuntimeEntryData entry_data, UserService service, ServiceCall call)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary ARG_TYPE_METADATA
 

Detailed Description

Manager for esphome devices.

Function Documentation

◆ _async_check_firmware_version()

None homeassistant.components.esphome.manager._async_check_firmware_version ( HomeAssistant  hass,
EsphomeDeviceInfo  device_info,
APIVersion   api_version 
)
private
Create or delete an the ble_firmware_outdated issue.

Definition at line 79 of file manager.py.

◆ _async_check_using_api_password()

None homeassistant.components.esphome.manager._async_check_using_api_password ( HomeAssistant  hass,
EsphomeDeviceInfo  device_info,
bool   has_password 
)
private
Create or delete an the api_password_deprecated issue.

Definition at line 110 of file manager.py.

◆ _async_register_service()

None homeassistant.components.esphome.manager._async_register_service ( HomeAssistant  hass,
RuntimeEntryData  entry_data,
EsphomeDeviceInfo  device_info,
UserService  service 
)
private
Register a service on a node.

Definition at line 681 of file manager.py.

◆ _async_setup_device_registry()

str homeassistant.components.esphome.manager._async_setup_device_registry ( HomeAssistant  hass,
ESPHomeConfigEntry  entry,
RuntimeEntryData   entry_data 
)
private
Set up device registry feature for a particular config entry.

Definition at line 559 of file manager.py.

◆ _setup_services()

None homeassistant.components.esphome.manager._setup_services ( HomeAssistant  hass,
RuntimeEntryData  entry_data,
list[UserService]   services 
)
private

Definition at line 731 of file manager.py.

◆ build_service_name()

str homeassistant.components.esphome.manager.build_service_name ( EsphomeDeviceInfo  device_info,
UserService  service 
)
Build a service name for a node.

Definition at line 675 of file manager.py.

◆ cleanup_instance()

RuntimeEntryData homeassistant.components.esphome.manager.cleanup_instance ( HomeAssistant  hass,
ESPHomeConfigEntry   entry 
)
Cleanup the esphome client if it exists.

Definition at line 764 of file manager.py.

◆ execute_service()

None homeassistant.components.esphome.manager.execute_service ( RuntimeEntryData  entry_data,
UserService  service,
ServiceCall   call 
)
Execute a service on a node.

Definition at line 668 of file manager.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.esphome.manager._LOGGER = logging.getLogger(__name__)
private

Definition at line 75 of file manager.py.

◆ ARG_TYPE_METADATA

dictionary homeassistant.components.esphome.manager.ARG_TYPE_METADATA

Definition at line 619 of file manager.py.