24b47b50ea
* Migrate from entry unique id to emoncms unique id * Use a placeholder for the documentation URL * Use async_set_unique_id in config_flow * use _abort_if_unique_id_configured in config_flow * Avoid single-use variable Co-authored-by: epenet <6771947+epenet@users.noreply.github.com> * Add async_migrate_entry * Remove commented code * Downgrade version if user add server without uuid * Improve code quality * Move code migrating HA to emoncms uuid to init * Fit doc url in less than 88 chars Co-authored-by: epenet <6771947+epenet@users.noreply.github.com> * Improve code quality * Only update unique_id with async_update_entry Co-authored-by: epenet <6771947+epenet@users.noreply.github.com> * Make emoncms_client compulsory to get_feed_list * Improve readability with unique id functions * Rmv test to give more sense to _migrate_unique_id --------- Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
87 lines
3.1 KiB
Python
87 lines
3.1 KiB
Python
"""The emoncms component."""
|
|
|
|
from pyemoncms import EmoncmsClient
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_API_KEY, CONF_URL, Platform
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import entity_registry as er
|
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
|
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
|
|
|
|
from .const import DOMAIN, EMONCMS_UUID_DOC_URL, LOGGER
|
|
from .coordinator import EmoncmsCoordinator
|
|
|
|
PLATFORMS: list[Platform] = [Platform.SENSOR]
|
|
|
|
type EmonCMSConfigEntry = ConfigEntry[EmoncmsCoordinator]
|
|
|
|
|
|
def _migrate_unique_id(
|
|
hass: HomeAssistant, entry: EmonCMSConfigEntry, emoncms_unique_id: str
|
|
) -> None:
|
|
"""Migrate to emoncms unique id if needed."""
|
|
ent_reg = er.async_get(hass)
|
|
entry_entities = ent_reg.entities.get_entries_for_config_entry_id(entry.entry_id)
|
|
for entity in entry_entities:
|
|
if entity.unique_id.split("-")[0] == entry.entry_id:
|
|
feed_id = entity.unique_id.split("-")[-1]
|
|
LOGGER.debug(f"moving feed {feed_id} to hardware uuid")
|
|
ent_reg.async_update_entity(
|
|
entity.entity_id, new_unique_id=f"{emoncms_unique_id}-{feed_id}"
|
|
)
|
|
hass.config_entries.async_update_entry(
|
|
entry,
|
|
unique_id=emoncms_unique_id,
|
|
)
|
|
|
|
|
|
async def _check_unique_id_migration(
|
|
hass: HomeAssistant, entry: EmonCMSConfigEntry, emoncms_client: EmoncmsClient
|
|
) -> None:
|
|
"""Check if we can migrate to the emoncms uuid."""
|
|
emoncms_unique_id = await emoncms_client.async_get_uuid()
|
|
if emoncms_unique_id:
|
|
if entry.unique_id != emoncms_unique_id:
|
|
_migrate_unique_id(hass, entry, emoncms_unique_id)
|
|
else:
|
|
async_create_issue(
|
|
hass,
|
|
DOMAIN,
|
|
"migrate database",
|
|
is_fixable=False,
|
|
issue_domain=DOMAIN,
|
|
severity=IssueSeverity.WARNING,
|
|
translation_key="migrate_database",
|
|
translation_placeholders={
|
|
"url": entry.data[CONF_URL],
|
|
"doc_url": EMONCMS_UUID_DOC_URL,
|
|
},
|
|
)
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: EmonCMSConfigEntry) -> bool:
|
|
"""Load a config entry."""
|
|
emoncms_client = EmoncmsClient(
|
|
entry.data[CONF_URL],
|
|
entry.data[CONF_API_KEY],
|
|
session=async_get_clientsession(hass),
|
|
)
|
|
await _check_unique_id_migration(hass, entry, emoncms_client)
|
|
coordinator = EmoncmsCoordinator(hass, emoncms_client)
|
|
await coordinator.async_config_entry_first_refresh()
|
|
entry.runtime_data = coordinator
|
|
|
|
entry.async_on_unload(entry.add_update_listener(update_listener))
|
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
|
return True
|
|
|
|
|
|
async def update_listener(hass: HomeAssistant, entry: ConfigEntry):
|
|
"""Handle options update."""
|
|
await hass.config_entries.async_reload(entry.entry_id)
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Unload a config entry."""
|
|
return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|