Home Assistant Unofficial Reference 2024.12.1
coordinator.py
Go to the documentation of this file.
1 """DataUpdateCoordinator for the co2signal integration."""
2 
3 from __future__ import annotations
4 
5 from datetime import timedelta
6 import logging
7 
8 from aioelectricitymaps import (
9  CarbonIntensityResponse,
10  ElectricityMaps,
11  ElectricityMapsError,
12  ElectricityMapsInvalidTokenError,
13 )
14 
15 from homeassistant.config_entries import ConfigEntry
16 from homeassistant.core import HomeAssistant
17 from homeassistant.exceptions import ConfigEntryAuthFailed
18 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
19 
20 from .const import DOMAIN
21 from .helpers import fetch_latest_carbon_intensity
22 
23 _LOGGER = logging.getLogger(__name__)
24 
25 
26 class CO2SignalCoordinator(DataUpdateCoordinator[CarbonIntensityResponse]):
27  """Data update coordinator."""
28 
29  config_entry: ConfigEntry
30 
31  def __init__(self, hass: HomeAssistant, client: ElectricityMaps) -> None:
32  """Initialize the coordinator."""
33  super().__init__(
34  hass, _LOGGER, name=DOMAIN, update_interval=timedelta(minutes=15)
35  )
36  self.clientclient = client
37 
38  @property
39  def entry_id(self) -> str:
40  """Return entry ID."""
41  return self.config_entryconfig_entry.entry_id
42 
43  async def _async_update_data(self) -> CarbonIntensityResponse:
44  """Fetch the latest data from the source."""
45 
46  try:
47  return await fetch_latest_carbon_intensity(
48  self.hasshass, self.clientclient, self.config_entryconfig_entry.data
49  )
50  except ElectricityMapsInvalidTokenError as err:
51  raise ConfigEntryAuthFailed from err
52  except ElectricityMapsError as err:
53  raise UpdateFailed(str(err)) from err
None __init__(self, HomeAssistant hass, ElectricityMaps client)
Definition: coordinator.py:31
CarbonIntensityResponse fetch_latest_carbon_intensity(HomeAssistant hass, ElectricityMaps em, Mapping[str, Any] config)
Definition: helpers.py:19