Allow more than one AirVisual config entry with the same API k… (#33072)
* Allow more than one AirVisual config entry with the same API key * Add tests * Correctly pop geography * Code review * Code review
This commit is contained in:
1 parent
109f083c5d
commit
0e2fa7700d
7 files changed
+169
-86
No files matched your search
@@ -1,5 +1,4 @@
|
||||
"""The airvisual component."""
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
from pyairvisual import Client
|
||||
@@ -23,7 +22,6 @@ from homeassistant.helpers.event import async_track_time_interval
|
||||
from .const import (
|
||||
CONF_CITY,
|
||||
CONF_COUNTRY,
|
||||
CONF_GEOGRAPHIES,
|
||||
DATA_CLIENT,
|
||||
DEFAULT_SCAN_INTERVAL,
|
||||
DOMAIN,
|
||||
@@ -36,7 +34,7 @@ DATA_LISTENER = "listener"
|
||||
|
||||
DEFAULT_OPTIONS = {CONF_SHOW_ON_MAP: True}
|
||||
|
||||
CONF_NODE_ID = "node_id"
|
||||
CONF_GEOGRAPHIES = "geographies"
|
||||
|
||||
GEOGRAPHY_COORDINATES_SCHEMA = vol.Schema(
|
||||
{
|
||||
@@ -70,34 +68,38 @@ CONFIG_SCHEMA = vol.Schema({DOMAIN: CLOUD_API_SCHEMA}, extra=vol.ALLOW_EXTRA)
|
||||
def async_get_geography_id(geography_dict):
|
||||
"""Generate a unique ID from a geography dict."""
|
||||
if CONF_CITY in geography_dict:
|
||||
return ",".join(
|
||||
return ", ".join(
|
||||
(
|
||||
geography_dict[CONF_CITY],
|
||||
geography_dict[CONF_STATE],
|
||||
geography_dict[CONF_COUNTRY],
|
||||
)
|
||||
)
|
||||
return ",".join(
|
||||
return ", ".join(
|
||||
(str(geography_dict[CONF_LATITUDE]), str(geography_dict[CONF_LONGITUDE]))
|
||||
)
|
||||
|
||||
|
||||
async def async_setup(hass, config):
|
||||
"""Set up the AirVisual component."""
|
||||
hass.data[DOMAIN] = {}
|
||||
hass.data[DOMAIN][DATA_CLIENT] = {}
|
||||
hass.data[DOMAIN][DATA_LISTENER] = {}
|
||||
hass.data[DOMAIN] = {DATA_CLIENT: {}, DATA_LISTENER: {}}
|
||||
|
||||
if DOMAIN not in config:
|
||||
return True
|
||||
|
||||
conf = config[DOMAIN]
|
||||
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={"source": SOURCE_IMPORT}, data=conf
|
||||
for geography in conf.get(
|
||||
CONF_GEOGRAPHIES,
|
||||
[{CONF_LATITUDE: hass.config.latitude, CONF_LONGITUDE: hass.config.longitude}],
|
||||
):
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN,
|
||||
context={"source": SOURCE_IMPORT},
|
||||
data={CONF_API_KEY: conf[CONF_API_KEY], **geography},
|
||||
)
|
||||
)
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
@@ -144,6 +146,45 @@ async def async_setup_entry(hass, config_entry):
|
||||
return True
|
||||
|
||||
|
||||
async def async_migrate_entry(hass, config_entry):
|
||||
"""Migrate an old config entry."""
|
||||
version = config_entry.version
|
||||
|
||||
_LOGGER.debug("Migrating from version %s", version)
|
||||
|
||||
# 1 -> 2: One geography per config entry
|
||||
if version == 1:
|
||||
version = config_entry.version = 2
|
||||
|
||||
# Update the config entry to only include the first geography (there is always
|
||||
# guaranteed to be at least one):
|
||||
data = {**config_entry.data}
|
||||
geographies = data.pop(CONF_GEOGRAPHIES)
|
||||
first_geography = geographies.pop(0)
|
||||
first_id = async_get_geography_id(first_geography)
|
||||
|
||||
hass.config_entries.async_update_entry(
|
||||
config_entry,
|
||||
unique_id=first_id,
|
||||
title=f"Cloud API ({first_id})",
|
||||
data={CONF_API_KEY: config_entry.data[CONF_API_KEY], **first_geography},
|
||||
)
|
||||
|
||||
# For any geographies that remain, create a new config entry for each one:
|
||||
for geography in geographies:
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN,
|
||||
context={"source": SOURCE_IMPORT},
|
||||
data={CONF_API_KEY: config_entry.data[CONF_API_KEY], **geography},
|
||||
)
|
||||
)
|
||||
|
||||
_LOGGER.info("Migration to version %s successful", version)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
async def async_unload_entry(hass, config_entry):
|
||||
"""Unload an AirVisual config entry."""
|
||||
hass.data[DOMAIN][DATA_CLIENT].pop(config_entry.entry_id)
|
||||
@@ -170,40 +211,28 @@ class AirVisualData:
|
||||
self._client = client
|
||||
self._hass = hass
|
||||
self.data = {}
|
||||
self.geography_data = config_entry.data
|
||||
self.geography_id = config_entry.unique_id
|
||||
self.options = config_entry.options
|
||||
|
||||
self.geographies = {
|
||||
async_get_geography_id(geography): geography
|
||||
for geography in config_entry.data[CONF_GEOGRAPHIES]
|
||||
}
|
||||
|
||||
async def async_update(self):
|
||||
"""Get new data for all locations from the AirVisual cloud API."""
|
||||
tasks = []
|
||||
if CONF_CITY in self.geography_data:
|
||||
api_coro = self._client.api.city(
|
||||
self.geography_data[CONF_CITY],
|
||||
self.geography_data[CONF_STATE],
|
||||
self.geography_data[CONF_COUNTRY],
|
||||
)
|
||||
else:
|
||||
api_coro = self._client.api.nearest_city(
|
||||
self.geography_data[CONF_LATITUDE], self.geography_data[CONF_LONGITUDE],
|
||||
)
|
||||
|
||||
for geography in self.geographies.values():
|
||||
if CONF_CITY in geography:
|
||||
tasks.append(
|
||||
self._client.api.city(
|
||||
geography[CONF_CITY],
|
||||
geography[CONF_STATE],
|
||||
geography[CONF_COUNTRY],
|
||||
)
|
||||
)
|
||||
else:
|
||||
tasks.append(
|
||||
self._client.api.nearest_city(
|
||||
geography[CONF_LATITUDE], geography[CONF_LONGITUDE],
|
||||
)
|
||||
)
|
||||
|
||||
results = await asyncio.gather(*tasks, return_exceptions=True)
|
||||
for geography_id, result in zip(self.geographies, results):
|
||||
if isinstance(result, AirVisualError):
|
||||
_LOGGER.error("Error while retrieving data: %s", result)
|
||||
self.data[geography_id] = {}
|
||||
continue
|
||||
self.data[geography_id] = result
|
||||
try:
|
||||
self.data[self.geography_id] = await api_coro
|
||||
except AirVisualError as err:
|
||||
_LOGGER.error("Error while retrieving data: %s", err)
|
||||
self.data[self.geography_id] = {}
|
||||
|
||||
_LOGGER.debug("Received new data")
|
||||
async_dispatcher_send(self._hass, TOPIC_UPDATE)
|
||||
|
||||
Reference in new issue
Block a user