Add device storage sensor entities to Xbox (home-assistant#155657)

Author: tr4nt0r

homeassistant/components/xbox/__init__.py

@@ -9,7 +9,12 @@
 from homeassistant.helpers import config_validation as cv
 
 from .const import DOMAIN
-from .coordinator import XboxConfigEntry, XboxUpdateCoordinator
+from .coordinator import (
+    XboxConfigEntry,
+    XboxConsolesCoordinator,
+    XboxCoordinators,
+    XboxUpdateCoordinator,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -30,7 +35,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: XboxConfigEntry) -> bool
     coordinator = XboxUpdateCoordinator(hass, entry)
     await coordinator.async_config_entry_first_refresh()
 
-    entry.runtime_data = coordinator
+    consoles = XboxConsolesCoordinator(hass, entry, coordinator)
+
+    entry.runtime_data = XboxCoordinators(coordinator, consoles)
 
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
@@ -53,16 +60,14 @@ async def async_migrate_unique_id(hass: HomeAssistant, entry: XboxConfigEntry) -
     if entry.version == 1 and entry.minor_version < 2:
         # Migrate unique_id from `xbox` to account xuid and
         # change generic entry name to user's gamertag
+        coordinator = entry.runtime_data.status
+        xuid = coordinator.client.xuid
+        gamertag = coordinator.data.presence[xuid].gamertag
+
         return hass.config_entries.async_update_entry(
             entry,
-            unique_id=entry.runtime_data.client.xuid,
-            title=(
-                entry.runtime_data.data.presence[
-                    entry.runtime_data.client.xuid
-                ].gamertag
-                if entry.title == "Home Assistant Cloud"
-                else entry.title
-            ),
+            unique_id=xuid,
+            title=(gamertag if entry.title == "Home Assistant Cloud" else entry.title),
             minor_version=2,
         )
 

homeassistant/components/xbox/binary_sensor.py

@@ -111,7 +111,7 @@ async def async_setup_entry(
 ) -> None:
     """Set up Xbox Live friends."""
     xuids_added: set[str] = set()
-    coordinator = entry.runtime_data
+    coordinator = entry.runtime_data.status
 
     @callback
     def add_entities() -> None:

homeassistant/components/xbox/coordinator.py

@@ -35,7 +35,7 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-type XboxConfigEntry = ConfigEntry[XboxUpdateCoordinator]
+type XboxConfigEntry = ConfigEntry[XboxCoordinators]
 
 
 @dataclass
@@ -55,6 +55,14 @@ class XboxData:
     title_info: dict[str, Title] = field(default_factory=dict)
 
 
+@dataclass
+class XboxCoordinators:
+    """Xbox coordinators."""
+
+    status: XboxUpdateCoordinator
+    consoles: XboxConsolesCoordinator
+
+
 class XboxUpdateCoordinator(DataUpdateCoordinator[XboxData]):
     """Store Xbox Console Status."""
 
@@ -280,3 +288,43 @@ def configured_as_entry(self) -> set[str]:
             for entry in self.hass.config_entries.async_entries(DOMAIN)
             if entry.unique_id is not None
         }
+
+
+class XboxConsolesCoordinator(DataUpdateCoordinator[SmartglassConsoleList]):
+    """Update list of Xbox consoles."""
+
+    config_entry: XboxConfigEntry
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        config_entry: XboxConfigEntry,
+        coordinator: XboxUpdateCoordinator,
+    ) -> None:
+        """Initialize."""
+        super().__init__(
+            hass,
+            _LOGGER,
+            config_entry=config_entry,
+            name=DOMAIN,
+            update_interval=timedelta(minutes=10),
+        )
+        self.client = coordinator.client
+        self.async_set_updated_data(coordinator.consoles)
+
+    async def _async_update_data(self) -> SmartglassConsoleList:
+        """Fetch console data."""
+
+        try:
+            return await self.client.smartglass.get_console_list()
+        except TimeoutException as e:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="timeout_exception",
+            ) from e
+        except (RequestError, HTTPStatusError) as e:
+            _LOGGER.debug("Xbox exception:", exc_info=True)
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="request_exception",
+            ) from e

homeassistant/components/xbox/image.py

@@ -64,7 +64,7 @@ async def async_setup_entry(
 ) -> None:
     """Set up Xbox images."""
 
-    coordinator = config_entry.runtime_data
+    coordinator = config_entry.runtime_data.status
 
     xuids_added: set[str] = set()
 

homeassistant/components/xbox/media_player.py

@@ -56,7 +56,7 @@ async def async_setup_entry(
 ) -> None:
     """Set up Xbox media_player from a config entry."""
 
-    coordinator = entry.runtime_data
+    coordinator = entry.runtime_data.status
 
     async_add_entities(
         [

homeassistant/components/xbox/media_source.py

@@ -112,7 +112,7 @@ async def async_resolve_media(self, item: MediaSourceItem) -> PlayMedia:
                 translation_key="account_not_configured",
             ) from e
 
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
 
         if identifier.media_type in (ATTR_GAMECLIPS, ATTR_COMMUNITY_GAMECLIPS):
             try:
@@ -302,7 +302,7 @@ async def _build_game_library(self, entry: XboxConfigEntry) -> BrowseMediaSource
     async def _build_games(self, entry: XboxConfigEntry) -> list[BrowseMediaSource]:
         """List Xbox games for the selected account."""
 
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
         if TYPE_CHECKING:
             assert entry.unique_id
         fields = [
@@ -346,7 +346,7 @@ async def _build_game_title(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> BrowseMediaSource:
         """Display game title."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
         try:
             game = (await client.titlehub.get_title_info(identifier.title_id)).titles[0]
         except TimeoutException as e:
@@ -402,7 +402,7 @@ async def _build_game_media(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> BrowseMediaSource:
         """List game media."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
         try:
             game = (await client.titlehub.get_title_info(identifier.title_id)).titles[0]
         except TimeoutException as e:
@@ -439,7 +439,7 @@ async def _build_media_items_gameclips(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> list[BrowseMediaSource]:
         """List media items."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
 
         if identifier.media_type != ATTR_GAMECLIPS:
             return []
@@ -483,7 +483,7 @@ async def _build_media_items_community_gameclips(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> list[BrowseMediaSource]:
         """List media items."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
 
         if identifier.media_type != ATTR_COMMUNITY_GAMECLIPS:
             return []
@@ -527,7 +527,7 @@ async def _build_media_items_screenshots(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> list[BrowseMediaSource]:
         """List media items."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
 
         if identifier.media_type != ATTR_SCREENSHOTS:
             return []
@@ -571,7 +571,7 @@ async def _build_media_items_community_screenshots(
         self, entry: XboxConfigEntry, identifier: XboxMediaSourceIdentifier
     ) -> list[BrowseMediaSource]:
         """List media items."""
-        client = entry.runtime_data.client
+        client = entry.runtime_data.status.client
 
         if identifier.media_type != ATTR_COMMUNITY_SCREENSHOTS:
             return []
@@ -640,7 +640,7 @@ def _build_media_items_promotional(
 
 def gamerpic(config_entry: XboxConfigEntry) -> str | None:
     """Return gamerpic."""
-    coordinator = config_entry.runtime_data
+    coordinator = config_entry.runtime_data.status
     if TYPE_CHECKING:
         assert config_entry.unique_id
     person = coordinator.data.presence[coordinator.client.xuid]

homeassistant/components/xbox/remote.py

@@ -27,7 +27,7 @@ async def async_setup_entry(
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up Xbox media_player from a config entry."""
-    coordinator = entry.runtime_data
+    coordinator = entry.runtime_data.status
 
     async_add_entities(
         [XboxRemote(console, coordinator) for console in coordinator.consoles.result]