Home Assistant Unofficial Reference 2024.12.1
__init__.py
Go to the documentation of this file.
1 """The Homeassistant Analytics integration."""
2 
3 from __future__ import annotations
4 
5 from dataclasses import dataclass
6 
7 from python_homeassistant_analytics import (
8  HomeassistantAnalyticsClient,
9  HomeassistantAnalyticsConnectionError,
10 )
11 
12 from homeassistant.config_entries import ConfigEntry
13 from homeassistant.const import Platform
14 from homeassistant.core import HomeAssistant
15 from homeassistant.exceptions import ConfigEntryNotReady
16 from homeassistant.helpers.aiohttp_client import async_get_clientsession
17 
18 from .const import CONF_TRACKED_INTEGRATIONS
19 from .coordinator import HomeassistantAnalyticsDataUpdateCoordinator
20 
21 PLATFORMS: list[Platform] = [Platform.SENSOR]
22 type AnalyticsInsightsConfigEntry = ConfigEntry[AnalyticsInsightsData]
23 
24 
25 @dataclass(frozen=True)
27  """Analytics data class."""
28 
29  coordinator: HomeassistantAnalyticsDataUpdateCoordinator
30  names: dict[str, str]
31 
32 
34  hass: HomeAssistant, entry: AnalyticsInsightsConfigEntry
35 ) -> bool:
36  """Set up Homeassistant Analytics from a config entry."""
37  client = HomeassistantAnalyticsClient(session=async_get_clientsession(hass))
38 
39  try:
40  integrations = await client.get_integrations()
41  except HomeassistantAnalyticsConnectionError as ex:
42  raise ConfigEntryNotReady("Could not fetch integration list") from ex
43 
44  names = {}
45  for integration in entry.options[CONF_TRACKED_INTEGRATIONS]:
46  if integration not in integrations:
47  names[integration] = integration
48  continue
49  names[integration] = integrations[integration].title
50 
51  coordinator = HomeassistantAnalyticsDataUpdateCoordinator(hass, client)
52 
53  await coordinator.async_config_entry_first_refresh()
54 
55  entry.runtime_data = AnalyticsInsightsData(coordinator=coordinator, names=names)
56 
57  await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
58  entry.async_on_unload(entry.add_update_listener(update_listener))
59 
60  return True
61 
62 
64  hass: HomeAssistant, entry: AnalyticsInsightsConfigEntry
65 ) -> bool:
66  """Unload a config entry."""
67  return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
68 
69 
70 async def update_listener(
71  hass: HomeAssistant, entry: AnalyticsInsightsConfigEntry
72 ) -> None:
73  """Handle options update."""
74  await hass.config_entries.async_reload(entry.entry_id)
bool async_unload_entry(HomeAssistant hass, AnalyticsInsightsConfigEntry entry)
Definition: __init__.py:65
None update_listener(HomeAssistant hass, AnalyticsInsightsConfigEntry entry)
Definition: __init__.py:72
bool async_setup_entry(HomeAssistant hass, AnalyticsInsightsConfigEntry entry)
Definition: __init__.py:35
aiohttp.ClientSession async_get_clientsession(HomeAssistant hass, bool verify_ssl=True, socket.AddressFamily family=socket.AF_UNSPEC, ssl_util.SSLCipherList ssl_cipher=ssl_util.SSLCipherList.PYTHON_DEFAULT)