homeassistant.components.esphome.dashboard Namespace Reference

Classes
class	ESPHomeDashboardManager

Functions
ESPHomeDashboardCoordinator|None	async_get_dashboard (HomeAssistant hass)
ESPHomeDashboardManager	async_get_or_create_dashboard_manager (HomeAssistant hass)
None	async_set_dashboard_info (HomeAssistant hass, str addon_slug, str host, int port)
None	async_setup (HomeAssistant hass)

Variables
	_LOGGER = logging.getLogger(__name__)
string	KEY_DASHBOARD_MANAGER = "esphome_dashboard_manager"
string	STORAGE_KEY = "esphome.dashboard"
int	STORAGE_VERSION = 1

Detailed Description

Files to interact with an ESPHome dashboard.

Function Documentation

async_get_dashboard()

ESPHomeDashboardCoordinator | None homeassistant.components.esphome.dashboard.async_get_dashboard

(

HomeAssistant

hass

)

Get an instance of the dashboard if set.

This is only safe to call after `async_setup` has been completed.

It should not be called from the config flow because there is a race
where manager can be an asyncio.Event instead of the actual manager
because the singleton decorator is not yet done.

Definition at line 134 of file dashboard.py.

async_get_or_create_dashboard_manager()

ESPHomeDashboardManager homeassistant.components.esphome.dashboard.async_get_or_create_dashboard_manager

(

HomeAssistant

hass

)

Get the dashboard manager or create it.

Definition at line 37 of file dashboard.py.

async_set_dashboard_info()

None homeassistant.components.esphome.dashboard.async_set_dashboard_info	(	HomeAssistant	hass,
		str	addon_slug,
		str	host,
		int	port
	)

Set the dashboard info.

Definition at line 147 of file dashboard.py.

async_setup()

None homeassistant.components.esphome.dashboard.async_setup

(

HomeAssistant

hass

)

Set up the ESPHome dashboard.

Definition at line 28 of file dashboard.py.

Variable Documentation

_LOGGER

homeassistant.components.esphome.dashboard._LOGGER = logging.getLogger(__name__)

private

Definition at line 19 of file dashboard.py.

KEY_DASHBOARD_MANAGER

string homeassistant.components.esphome.dashboard.KEY_DASHBOARD_MANAGER = "esphome_dashboard_manager"

Definition at line 22 of file dashboard.py.

STORAGE_KEY

string homeassistant.components.esphome.dashboard.STORAGE_KEY = "esphome.dashboard"

Definition at line 24 of file dashboard.py.

STORAGE_VERSION

int homeassistant.components.esphome.dashboard.STORAGE_VERSION = 1

Definition at line 25 of file dashboard.py.