update.py

Go to the documentation of this file.

"""Support for Litter-Robot updates."""
 
from __future__ import annotations
 
from datetime import timedelta
from typing import Any
 
from pylitterbot import LitterRobot4
 
from homeassistant.components.update import (
    UpdateDeviceClass,
    UpdateEntity,
    UpdateEntityDescription,
    UpdateEntityFeature,
)
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import LitterRobotConfigEntry
from .entity import LitterRobotEntity
 
SCAN_INTERVAL = timedelta(days=1)
 
FIRMWARE_UPDATE_ENTITY = UpdateEntityDescription(
    key="firmware",
    device_class=UpdateDeviceClass.FIRMWARE,
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: LitterRobotConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up Litter-Robot update platform."""
    hub = entry.runtime_data
    entities = [
        RobotUpdateEntity(robot=robot, hub=hub, description=FIRMWARE_UPDATE_ENTITY)
        for robot in hub.litter_robots()
        if isinstance(robot, LitterRobot4)
    ]
    async_add_entities(entities, True)
 
 
class RobotUpdateEntity(LitterRobotEntity[LitterRobot4], UpdateEntity):
    """A class that describes robot update entities."""
 
    _attr_supported_features = (
        UpdateEntityFeature.INSTALL | UpdateEntityFeature.PROGRESS
    )
 
    @property
    def installed_version(self) -> str:
        """Version installed and in use."""
        return self.robotrobot.firmware
 
    @property
    def in_progress(self) -> bool:
        """Update installation progress."""
        return self.robotrobot.firmware_update_triggered
 
    @property
    def should_poll(self) -> bool:
        """Set polling to True."""
        return True
 
    async def async_update(self) -> None:
        """Update the entity."""
        # If the robot has a firmware update already in progress, checking for the
        # latest firmware informs that an update has already been triggered, no
        # firmware information is returned and we won't know the latest version.
        if not self.robotrobot.firmware_update_triggered:
            latest_version = await self.robotrobot.get_latest_firmware(True)
            if not await self.robotrobot.has_firmware_update():
                latest_version = self.robotrobot.firmware
            self._attr_latest_version_attr_latest_version = latest_version
 
    async def async_install(
        self, version: str | None, backup: bool, **kwargs: Any
    ) -> None:
        """Install an update."""
        if await self.robotrobot.has_firmware_update(True):
            if not await self.robotrobot.update_firmware():
                message = f"Unable to start firmware update on {self.robot.name}"
                raise HomeAssistantError(message)