update.py

Go to the documentation of this file.

"""Update entities for Linn devices."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import aiohttp
from async_upnp_client.client import UpnpError
 
from homeassistant.components.update import (
    UpdateDeviceClass,
    UpdateEntity,
    UpdateEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up update entities for Reolink component."""
 
    _LOGGER.debug("Setting up config entry: %s", config_entry.unique_id)
 
    device = hass.data[DOMAIN][config_entry.entry_id]
 
    entity = OpenhomeUpdateEntity(device)
 
    await entity.async_update()
 
    async_add_entities([entity])
 
 
class OpenhomeUpdateEntity(UpdateEntity):
    """Update entity for a Linn DS device."""
 
    _attr_device_class = UpdateDeviceClass.FIRMWARE
    _attr_supported_features = UpdateEntityFeature.INSTALL
    _attr_has_entity_name = True
    _attr_name = None
 
    def __init__(self, device):
        """Initialize a Linn DS update entity."""
        self._device_device = device
        self._attr_unique_id_attr_unique_id = f"{device.uuid()}-update"
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={
                (DOMAIN, device.uuid()),
            },
            manufacturer=device.manufacturer(),
            model=device.model_name(),
            name=device.friendly_name(),
        )
 
    async def async_update(self) -> None:
        """Update state of entity."""
 
        software_status = await self._device_device.software_status()
 
        if not software_status:
            self._attr_installed_version_attr_installed_version = None
            self._attr_latest_version_attr_latest_version = None
            self._attr_release_summary_attr_release_summary = None
            self._attr_release_url_attr_release_url = None
            return
 
        self._attr_installed_version_attr_installed_version = software_status["current_software"]["version"]
 
        if software_status["status"] == "update_available":
            self._attr_latest_version_attr_latest_version = software_status["update_info"]["updates"][0][
                "version"
            ]
            self._attr_release_summary_attr_release_summary = software_status["update_info"]["updates"][0][
                "description"
            ]
            self._attr_release_url_attr_release_url = software_status["update_info"]["releasenotesuri"]
 
    async def async_install(
        self, version: str | None, backup: bool, **kwargs: Any
    ) -> None:
        """Install the latest firmware version."""
        try:
            if self.latest_versionlatest_version:
                await self._device_device.update_firmware()
        except (TimeoutError, aiohttp.ClientError, UpnpError) as err:
            raise HomeAssistantError(
                f"Error updating {self._device.device.friendly_name}: {err}"
            ) from err