External app name + icon metadata

README.md

@@ -1,6 +1,6 @@
 # Android TV integration for Remote Two/3
 
-Using [androidtvremote2](https://github.com/tronikos/androidtvremote2), [uc-integration-api](https://github.com/aitatoi/integration-python-library) and [pychromecast](https://github.com/home-assistant-libs/pychromecast).
+Using [androidtvremote2](https://github.com/tronikos/androidtvremote2), [uc-integration-api](https://github.com/aitatoi/integration-python-library), [pychromecast](https://github.com/home-assistant-libs/pychromecast) and [google-play-scraper](https://github.com/JoMingyu/google-play-scraper).
 
 The integration currently supports almost all features that the androidtvremote2 library provides.
 Button control and ON/OFF states are supported. With the optional Google Cast support, media playing information can be 
@@ -16,6 +16,7 @@ Android TV devices. It can be run as an external integration for development
   is exposed per Android TV device to the Remote.
 - Device profiles allow device specific support and custom key bindings, for example double-click or long-press actions.  
   See [command mappings](docs/command_mapping.md) for more information.
+- Optional external metadata lookup using the Google Play Store
 
 ## Standalone Usage
 ### Setup

data/external_cache/app_metadata.json

@@ -0,0 +1,10 @@
+{
+  "com.google.android.tvlauncher": {
+    "name": "Android TV Home",
+    "icon": "data/external_cache/icons/androidtv.png"
+  },
+  "com.google.android.backdrop": {
+    "name": "Backdrop Daydream",
+    "icon": "data/external_cache/icons/androidtv.png"
+  }
+}

intg-androidtv/apps.py

@@ -60,6 +60,7 @@
     "tv.wuaki": "Rakuten TV",
     "homedia.sky.sport": "SKY",
     "com.teamsmart.videomanager.tv": "SmartTube",
+    "com.nathnetwork.supersmart": "SuperSmart",
     "nl.rtl.videoland.v2": "Videoland",
     "com.disney.disneyplus": "Disney+",
     "com.netflix.ninja": "Netflix",
@@ -87,6 +88,7 @@
 # Used to show which app is currently in the foreground (currently playing)
 NameMatching = {
     "youtube": "YouTube",
+    "videomanager": "YouTube",
     "amazonvideo": "Prime Video",
     "apple": "Apple TV",
     "plex": "Plex",

intg-androidtv/config.py

@@ -34,6 +34,8 @@ class AtvDevice:
     """Device model name."""
     auth_error: bool = False
     """Authentication error, device requires pairing."""
+    use_external_metadata: bool = False
+    """Enable External Metadata."""
     use_chromecast: bool = False
     """Enable Chromecast features."""
 
@@ -129,6 +131,7 @@ def update(self, atv: AtvDevice) -> bool:
                 item.manufacturer = atv.manufacturer
                 item.model = atv.model
                 item.auth_error = atv.auth_error
+                item.use_external_metadata = atv.use_external_metadata
                 item.use_chromecast = atv.use_chromecast
                 return self.store()
         return False
@@ -184,7 +187,11 @@ def clear(self) -> None:
             try:
                 os.remove(file)
             except OSError as ex:
-                _LOG.error("Failed to remove certificate file %s: %s", os.path.basename(file), ex)
+                _LOG.error(
+                    "Failed to remove certificate file %s: %s",
+                    os.path.basename(file),
+                    ex,
+                )
 
         self._config = []
 
@@ -227,6 +234,7 @@ def load(self) -> bool:
                     item.get("manufacturer", ""),
                     item.get("model", ""),
                     item.get("auth_error", False),
+                    item.get("use_external_metadata", False),
                     item.get("use_chromecast", False),
                 )
                 self._config.append(atv)
@@ -268,9 +276,9 @@ async def migrate(self) -> bool:
                 android_tv = AndroidTv(self.certfile(item.id), self.keyfile(item.id), item)
                 if await android_tv.init(10) and await android_tv.connect(10):
                     if device_info := android_tv.device_info:
-                        item.manufacturer = android_tv.device_info
                         item.manufacturer = device_info.get("manufacturer", "")
                         item.model = device_info.get("model", "")
+                        item.use_external_metadata = device_info.get("use_external_metadata", False)
 
                         _LOG.info(
                             "Updating device configuration '%s' (%s) with: manufacturer=%s, model=%s",
@@ -336,7 +344,11 @@ def assign_default_certs_to_device(self, atv_id: str, force: bool = False) -> bo
                 )
                 os.rename(old_keyfile, new_file)
             except OSError as ex:
-                _LOG.error("Error while migrating certificate file %s: %s", os.path.basename(new_file), ex)
+                _LOG.error(
+                    "Error while migrating certificate file %s: %s",
+                    os.path.basename(new_file),
+                    ex,
+                )
                 return False
         return True
 

intg-androidtv/discover.py

@@ -24,7 +24,10 @@ async def android_tvs(timeout: int = 10) -> list[dict[str, str]]:
     discovered_android_tvs: list[dict[str, str]] = []
 
     def on_service_state_changed(
-        zeroconf: Zeroconf, service_type: str, name: str, state_change: ServiceStateChange
+        zeroconf: Zeroconf,
+        service_type: str,
+        name: str,
+        state_change: ServiceStateChange,
     ) -> None:
         if state_change is not ServiceStateChange.Added:
             return
@@ -44,7 +47,11 @@ async def display_service_info(zeroconf: Zeroconf, service_type: str, name: str)
 
             addresses = info.parsed_scoped_addresses()
             if addresses:
-                discovered_tv = {"name": name_final, "label": f"{name_final} [{addresses[0]}]", "address": addresses[0]}
+                discovered_tv = {
+                    "name": name_final,
+                    "label": f"{name_final} [{addresses[0]}]",
+                    "address": addresses[0],
+                }
                 discovered_android_tvs.append(discovered_tv)
         else:
             _LOG.debug("No info for %s", name)

intg-androidtv/driver.py

@@ -10,6 +10,7 @@
 import logging
 import os
 import sys
+from copy import copy
 from datetime import UTC, datetime
 from typing import Any
 
@@ -232,7 +233,11 @@ async def handle_android_tv_update(atv_id: str, update: dict[str, Any]) -> None:
 
     if _LOG.isEnabledFor(logging.DEBUG):
         device = config.devices.get(atv_id)
-        _LOG.debug("[%s] device update: %s", device.name if device else atv_id, update)
+        # filter media_image_url property
+        log_upd = copy(update)
+        if MediaAttr.MEDIA_IMAGE_URL in log_upd:
+            log_upd[MediaAttr.MEDIA_IMAGE_URL] = "***"
+            _LOG.debug("[%s] device update: %s", device.name if device else atv_id, log_upd)
 
     old_state = (
         configured_entity.attributes[MediaAttr.STATE]
@@ -407,6 +412,7 @@ async def main():
     logging.getLogger("profiles").setLevel(level)
     logging.getLogger("setup_flow").setLevel(level)
     logging.getLogger("androidtvremote2").setLevel(level)
+    logging.getLogger("external_metadata").setLevel(level)
     # logging.getLogger("pychromecast").setLevel(level)
 
     profile_path = os.path.join(api.config_dir_path, "profiles")

intg-androidtv/external_metadata.py

@@ -0,0 +1,182 @@
+"""
+External metadata retrieval from Google Play.
+
+:copyright: (c) 2025 by thomasm789, www.tmason.uk
+:license: MPL-2.0, see LICENSE for more details.
+"""
+
+import base64
+import json
+import logging
+import os
+from io import BytesIO
+from pathlib import Path
+from typing import Dict
+from urllib.parse import urlparse
+
+import google_play_scraper
+import requests
+from PIL import Image
+from PIL.Image import Resampling
+from pychromecast.controllers.media import MediaImage
+
+_LOG = logging.getLogger(__name__)
+
+CACHE_ROOT = "external_cache"
+ICON_SUBDIR = "icons"
+ICON_SIZE = (120, 120)
+
+
+# Paths
+def _get_cache_root() -> Path:
+    config_home = Path(os.environ.get("UC_DATA_HOME", "./data"))
+    cache_root = config_home / CACHE_ROOT
+    cache_root.mkdir(parents=True, exist_ok=True)
+    return cache_root
+
+
+def _get_metadata_dir() -> Path:
+    metadata_dir = _get_cache_root()
+    metadata_dir.mkdir(parents=True, exist_ok=True)
+    return metadata_dir
+
+
+def _get_icon_dir() -> Path:
+    icon_dir = _get_cache_root() / ICON_SUBDIR
+    icon_dir.mkdir(parents=True, exist_ok=True)
+    return icon_dir
+
+
+def _get_metadata_file_path() -> Path:
+    return _get_metadata_dir() / "app_metadata.json"
+
+
+def _get_icon_path(package_id: str) -> Path:
+    return _get_icon_dir() / f"{package_id}.png"
+
+
+# Cache Management
+def _load_cache() -> Dict[str, Dict[str, str]]:
+    path = _get_metadata_file_path()
+    if path.exists():
+        try:
+            with open(path, "r", encoding="utf-8") as f:
+                return json.load(f)
+        except Exception:
+            return {}
+    return {}
+
+
+def _save_cache(cache: Dict[str, Dict[str, str]]) -> None:
+    path = _get_metadata_file_path()
+    with open(path, "w", encoding="utf-8") as f:
+        json.dump(cache, f, indent=2)
+
+
+# Metadata Fetch
+def _download_and_resize_icon(url: str, package_id: str) -> str | None:
+    try:
+        response = requests.get(url, timeout=10)
+        response.raise_for_status()
+
+        img = Image.open(BytesIO(response.content))
+        img = img.resize(ICON_SIZE, Resampling.LANCZOS)
+
+        icon_path = _get_icon_path(package_id)
+        img.save(icon_path, format="PNG")
+        return str(icon_path)
+    except Exception as e:
+        _LOG.warning("Failed to fetch icon for %s: %s", package_id, e)
+        return None
+
+
+def encode_icon_to_data_uri(icon_path: str) -> str:
+    """
+    Encode an image from a local file path or remote URL.
+
+    Returns a base64-encoded PNG data URI.
+    """
+    if isinstance(icon_path, MediaImage):
+        icon_path = icon_path.url
+
+    # Already a base64 data URI
+    if isinstance(icon_path, str) and icon_path.startswith("data:image"):
+        return icon_path
+
+    try:
+        if _is_url(icon_path):
+            response = requests.get(icon_path, timeout=10)
+            response.raise_for_status()
+            img = Image.open(BytesIO(response.content))
+        else:
+            with open(icon_path, "rb") as f:
+                img = Image.open(f)
+                img.load()  # Ensure the image is fully loaded before the file is closed
+
+        img = img.convert("RGBA")
+
+        buffer = BytesIO()
+        img.save(buffer, format="PNG")
+        encoded = base64.b64encode(buffer.getvalue()).decode("utf-8")
+        return f"data:image/png;base64,{encoded}"
+
+    except Exception as e:
+        _LOG.warning("Failed to encode icon to base64 for %s: %s", icon_path, e)
+        return ""
+
+
+def _is_url(path: str) -> bool:
+    parsed = urlparse(path)
+    return parsed.scheme in ("http", "https")
+
+
+def _fetch_google_play_metadata(package_id: str) -> Dict[str, str] | None:
+    try:
+        app = google_play_scraper.app(package_id)
+
+        name = app["title"]
+        icon_url = app["icon"]
+        icon_path = _download_and_resize_icon(icon_url, package_id)
+
+        return {"name": name, "icon": icon_path or ""}
+
+    except Exception as e:
+        _LOG.warning("Google Play metadata fetch failed for %s: %s", package_id, e)
+        return None
+
+
+def get_app_metadata(package_id: str) -> Dict[str, str]:
+    """
+    Fetch metadata for a mobile application specified by the package ID.
+
+    The metadata includes the application name and its icon encoded as a data URI.
+    If metadata is found in a locally cached source, it is fetched from the cache.
+    Otherwise, metadata is retrieved from external sources such as Google Play.
+
+    :param package_id: The unique package identifier for the application.
+    :type package_id: str
+    :return: A dictionary containing the application's metadata. The dictionary
+             includes the 'name' of the application and the 'icon', which is the
+             application's icon encoded as a data URI. If no metadata is found,
+             it returns the package ID as the name and an empty string as the icon.
+    :rtype: Dict[str, str]
+    """
+    cache = _load_cache()
+    if package_id in cache:
+        icon_path = cache[package_id].get("icon")
+        icon_data_uri = encode_icon_to_data_uri(icon_path) if icon_path else ""
+        return {"name": cache[package_id]["name"], "icon": icon_data_uri}
+
+    # Try Google Play
+    metadata = _fetch_google_play_metadata(package_id)
+    # if not metadata:
+    # Additional Fallback option for the future maybe APKPure or another source
+    # metadata = fetch_fallback_metadata(package_id)
+
+    if metadata:
+        cache[package_id] = metadata
+        _save_cache(cache)
+        icon_data_uri = encode_icon_to_data_uri(metadata["icon"]) if metadata["icon"] else ""
+        return {"name": metadata["name"], "icon": icon_data_uri}
+
+    return {"name": package_id, "icon": ""}