Add update entity platform (home-assistant#68248)

Co-authored-by: Glenn Waters <glenn@watrs.ca>

.core_files.yaml

@@ -39,6 +39,7 @@ base_platforms: &base_platforms
   - homeassistant/components/stt/**
   - homeassistant/components/switch/**
   - homeassistant/components/tts/**
+  - homeassistant/components/update/**
   - homeassistant/components/vacuum/**
   - homeassistant/components/water_heater/**
   - homeassistant/components/weather/**

.strict-typing

@@ -207,6 +207,7 @@ homeassistant.components.tts.*
 homeassistant.components.twentemilieu.*
 homeassistant.components.unifiprotect.*
 homeassistant.components.upcloud.*
+homeassistant.components.update.*
 homeassistant.components.uptime.*
 homeassistant.components.uptimerobot.*
 homeassistant.components.usb.*

CODEOWNERS

@@ -1059,6 +1059,8 @@ tests/components/upb/* @gwww
 homeassistant/components/upc_connect/* @pvizeli @fabaff
 homeassistant/components/upcloud/* @scop
 tests/components/upcloud/* @scop
+homeassistant/components/update/* @home-assistant/core
+tests/components/update/* @home-assistant/core
 homeassistant/components/updater/* @home-assistant/core
 tests/components/updater/* @home-assistant/core
 homeassistant/components/upnp/* @StevenLooman @ehendrix23

homeassistant/components/demo/__init__.py

@@ -40,6 +40,7 @@
     "sensor",
     "siren",
     "switch",
+    "update",
     "vacuum",
     "water_heater",
 ]

homeassistant/components/demo/update.py

@@ -0,0 +1,153 @@
+"""Demo platform that offers fake update entities."""
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+from homeassistant.components.update import UpdateDeviceClass, UpdateEntity
+from homeassistant.components.update.const import UpdateEntityFeature
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import DEVICE_DEFAULT_NAME
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity import DeviceInfo
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
+
+from . import DOMAIN
+
+FAKE_INSTALL_SLEEP_TIME = 0.5
+
+
+async def async_setup_platform(
+    hass: HomeAssistant,
+    config: ConfigType,
+    async_add_entities: AddEntitiesCallback,
+    discovery_info: DiscoveryInfoType | None = None,
+) -> None:
+    """Set up demo update entities."""
+    async_add_entities(
+        [
+            DemoUpdate(
+                unique_id="update_no_install",
+                name="Demo Update No Install",
+                title="Awesomesoft Inc.",
+                current_version="1.0.0",
+                latest_version="1.0.1",
+                release_summary="Awesome update, fixing everything!",
+                release_url="https://www.example.com/release/1.0.1",
+                support_install=False,
+            ),
+            DemoUpdate(
+                unique_id="update_2_date",
+                name="Demo No Update",
+                title="AdGuard Home",
+                current_version="1.0.0",
+                latest_version="1.0.0",
+            ),
+            DemoUpdate(
+                unique_id="update_addon",
+                name="Demo add-on",
+                title="AdGuard Home",
+                current_version="1.0.0",
+                latest_version="1.0.1",
+                release_summary="Awesome update, fixing everything!",
+                release_url="https://www.example.com/release/1.0.1",
+            ),
+            DemoUpdate(
+                unique_id="update_light_bulb",
+                name="Demo Living Room Bulb Update",
+                title="Philips Lamps Firmware",
+                current_version="1.93.3",
+                latest_version="1.94.2",
+                release_summary="Added support for effects",
+                release_url="https://www.example.com/release/1.93.3",
+                device_class=UpdateDeviceClass.FIRMWARE,
+            ),
+            DemoUpdate(
+                unique_id="update_support_progress",
+                name="Demo Update with Progress",
+                title="Philips Lamps Firmware",
+                current_version="1.93.3",
+                latest_version="1.94.2",
+                support_progress=True,
+                release_summary="Added support for effects",
+                release_url="https://www.example.com/release/1.93.3",
+                device_class=UpdateDeviceClass.FIRMWARE,
+            ),
+        ]
+    )
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the Demo config entry."""
+    await async_setup_platform(hass, {}, async_add_entities)
+
+
+async def _fake_install() -> None:
+    """Fake install an update."""
+    await asyncio.sleep(FAKE_INSTALL_SLEEP_TIME)
+
+
+class DemoUpdate(UpdateEntity):
+    """Representation of a demo update entity."""
+
+    _attr_should_poll = False
+
+    def __init__(
+        self,
+        *,
+        unique_id: str,
+        name: str,
+        title: str | None,
+        current_version: str | None,
+        latest_version: str | None,
+        release_summary: str | None = None,
+        release_url: str | None = None,
+        support_progress: bool = False,
+        support_install: bool = True,
+        device_class: UpdateDeviceClass | None = None,
+    ) -> None:
+        """Initialize the Demo select entity."""
+        self._attr_current_version = current_version
+        self._attr_device_class = device_class
+        self._attr_latest_version = latest_version
+        self._attr_name = name or DEVICE_DEFAULT_NAME
+        self._attr_release_summary = release_summary
+        self._attr_release_url = release_url
+        self._attr_title = title
+        self._attr_unique_id = unique_id
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, unique_id)},
+            name=name,
+        )
+        if support_install:
+            self._attr_supported_features |= (
+                UpdateEntityFeature.INSTALL
+                | UpdateEntityFeature.BACKUP
+                | UpdateEntityFeature.SPECIFIC_VERSION
+            )
+        if support_progress:
+            self._attr_supported_features |= UpdateEntityFeature.PROGRESS
+
+    async def async_install(
+        self,
+        version: str | None = None,
+        backup: bool | None = None,
+        **kwargs: Any,
+    ) -> None:
+        """Install an update."""
+        if self.supported_features & UpdateEntityFeature.PROGRESS:
+            for progress in range(0, 100, 10):
+                self._attr_in_progress = progress
+                self.async_write_ha_state()
+                await _fake_install()
+
+        self._attr_in_progress = False
+        self._attr_current_version = (
+            version if version is not None else self.latest_version
+        )
+        self.async_write_ha_state()