Add image platform to Xbox integration (#155369)

Co-authored-by: Josef Zweck <josef@zweck.dev>

Author: tr4nt0r

homeassistant/components/xbox/__init__.py

@@ -17,6 +17,7 @@
 
 PLATFORMS = [
     Platform.BINARY_SENSOR,
+    Platform.IMAGE,
     Platform.MEDIA_PLAYER,
     Platform.REMOTE,
     Platform.SENSOR,

homeassistant/components/xbox/binary_sensor.py

@@ -9,7 +9,6 @@
 
 from xbox.webapi.api.provider.people.models import Person
 from xbox.webapi.api.provider.titlehub.models import Title
-from yarl import URL
 
 from homeassistant.components.binary_sensor import (
     DOMAIN as BINARY_SENSOR_DOMAIN,
@@ -20,7 +19,12 @@
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from .coordinator import XboxConfigEntry
-from .entity import XboxBaseEntity, XboxBaseEntityDescription, check_deprecated_entity
+from .entity import (
+    XboxBaseEntity,
+    XboxBaseEntityDescription,
+    check_deprecated_entity,
+    profile_pic,
+)
 
 
 class XboxBinarySensor(StrEnum):
@@ -43,23 +47,6 @@ class XboxBinarySensorEntityDescription(
     deprecated: bool | None = None
 
 
-def profile_pic(person: Person, _: Title | None) -> str | None:
-    """Return the gamer pic."""
-
-    # Xbox sometimes returns a domain that uses a wrong certificate which
-    # creates issues with loading the image.
-    # The correct domain is images-eds-ssl which can just be replaced
-    # to point to the correct image, with the correct domain and certificate.
-    # We need to also remove the 'mode=Padding' query because with it,
-    # it results in an error 400.
-    url = URL(person.display_pic_raw)
-    if url.host == "images-eds.xboxlive.com":
-        url = url.with_host("images-eds-ssl.xboxlive.com").with_scheme("https")
-    query = dict(url.query)
-    query.pop("mode", None)
-    return str(url.with_query(query))
-
-
 def profile_attributes(person: Person, _: Title | None) -> dict[str, Any]:
     """Attributes for the profile."""
     attributes: dict[str, Any] = {}

homeassistant/components/xbox/entity.py

@@ -9,6 +9,7 @@
 from xbox.webapi.api.provider.people.models import Person
 from xbox.webapi.api.provider.smartglass.models import ConsoleType, SmartglassConsole
 from xbox.webapi.api.provider.titlehub.models import Title
+from yarl import URL
 
 from homeassistant.components.automation import automations_with_entity
 from homeassistant.components.script import scripts_with_entity
@@ -39,6 +40,7 @@ class XboxBaseEntityDescription(EntityDescription):
     attributes_fn: Callable[[Person, Title | None], Mapping[str, Any] | None] | None = (
         None
     )
+    deprecated: bool | None = None
 
 
 class XboxBaseEntity(CoordinatorEntity[XboxUpdateCoordinator]):
@@ -157,3 +159,20 @@ def check_deprecated_entity(
         ent_reg.async_remove(entity_id)
 
     return False
+
+
+def profile_pic(person: Person, _: Title | None) -> str | None:
+    """Return the gamer pic."""
+
+    # Xbox sometimes returns a domain that uses a wrong certificate which
+    # creates issues with loading the image.
+    # The correct domain is images-eds-ssl which can just be replaced
+    # to point to the correct image, with the correct domain and certificate.
+    # We need to also remove the 'mode=Padding' query because with it,
+    # it results in an error 400.
+    url = URL(person.display_pic_raw)
+    if url.host == "images-eds.xboxlive.com":
+        url = url.with_host("images-eds-ssl.xboxlive.com").with_scheme("https")
+    query = dict(url.query)
+    query.pop("mode", None)
+    return str(url.with_query(query))

homeassistant/components/xbox/image.py

@@ -0,0 +1,123 @@
+"""Image platform for the Xbox integration."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from enum import StrEnum
+
+from xbox.webapi.api.provider.people.models import Person
+from xbox.webapi.api.provider.titlehub.models import Title
+
+from homeassistant.components.image import ImageEntity, ImageEntityDescription
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+from homeassistant.util import dt as dt_util
+
+from .coordinator import XboxConfigEntry, XboxUpdateCoordinator
+from .entity import XboxBaseEntity, XboxBaseEntityDescription, profile_pic
+
+PARALLEL_UPDATES = 0
+
+
+class XboxImage(StrEnum):
+    """Xbox image."""
+
+    NOW_PLAYING = "now_playing"
+    GAMERPIC = "gamerpic"
+    AVATAR = "avatar"
+
+
+@dataclass(kw_only=True, frozen=True)
+class XboxImageEntityDescription(XboxBaseEntityDescription, ImageEntityDescription):
+    """Xbox image description."""
+
+    image_url_fn: Callable[[Person, Title | None], str | None]
+
+
+IMAGE_DESCRIPTIONS: tuple[XboxImageEntityDescription, ...] = (
+    XboxImageEntityDescription(
+        key=XboxImage.GAMERPIC,
+        translation_key=XboxImage.GAMERPIC,
+        image_url_fn=profile_pic,
+    ),
+    XboxImageEntityDescription(
+        key=XboxImage.NOW_PLAYING,
+        translation_key=XboxImage.NOW_PLAYING,
+        image_url_fn=lambda _, title: title.display_image if title else None,
+    ),
+    XboxImageEntityDescription(
+        key=XboxImage.AVATAR,
+        translation_key=XboxImage.AVATAR,
+        image_url_fn=(
+            lambda person,
+            _: f"https://avatar-ssl.xboxlive.com/avatar/{person.gamertag}/avatar-body.png"
+        ),
+    ),
+)
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: XboxConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up Xbox images."""
+
+    coordinator = config_entry.runtime_data
+
+    xuids_added: set[str] = set()
+
+    @callback
+    def add_entities() -> None:
+        """Add image entities."""
+        nonlocal xuids_added
+
+        current_xuids = set(coordinator.data.presence)
+        if new_xuids := current_xuids - xuids_added:
+            async_add_entities(
+                [
+                    XboxImageEntity(hass, coordinator, xuid, description)
+                    for xuid in new_xuids
+                    for description in IMAGE_DESCRIPTIONS
+                ]
+            )
+            xuids_added |= new_xuids
+        xuids_added &= current_xuids
+
+    coordinator.async_add_listener(add_entities)
+    add_entities()
+
+
+class XboxImageEntity(XboxBaseEntity, ImageEntity):
+    """An image entity."""
+
+    entity_description: XboxImageEntityDescription
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        coordinator: XboxUpdateCoordinator,
+        xuid: str,
+        entity_description: XboxImageEntityDescription,
+    ) -> None:
+        """Initialize the image entity."""
+        super().__init__(coordinator, xuid, entity_description)
+        ImageEntity.__init__(self, hass)
+
+        self._attr_image_url = self.entity_description.image_url_fn(
+            self.data, self.title_info
+        )
+        self._attr_image_last_updated = dt_util.utcnow()
+
+    def _handle_coordinator_update(self) -> None:
+        """Handle updated data from the coordinator."""
+
+        url = self.entity_description.image_url_fn(self.data, self.title_info)
+
+        if url != self._attr_image_url:
+            self._attr_image_url = url
+            self._cached_image = None
+            self._attr_image_last_updated = dt_util.utcnow()
+
+        super()._handle_coordinator_update()

homeassistant/components/xbox/strings.json

@@ -44,6 +44,17 @@
         }
       }
     },
+    "image": {
+      "avatar": {
+        "name": "Avatar"
+      },
+      "gamerpic": {
+        "name": "Gamerpic"
+      },
+      "now_playing": {
+        "name": "[%key:component::xbox::entity::sensor::now_playing::name%]"
+      }
+    },
     "sensor": {
       "follower": {
         "name": "Follower",