Merge pull request #18 from natekspencer/dev

Better error handling

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

README.md

@@ -1,6 +1,9 @@
-![Release](https://img.shields.io/github/v/release/natekspencer/hacs-oasis_mini?style=for-the-badge)
+[![Release](https://img.shields.io/github/v/release/natekspencer/hacs-oasis_mini?style=for-the-badge)](https://github.com/natekspencer/hacs-oasis_mini/releases)
 [![Buy Me A Coffee/Beer](https://img.shields.io/badge/Buy_Me_A_☕/🍺-F16061?style=for-the-badge&logo=ko-fi&logoColor=white&labelColor=grey)](https://ko-fi.com/natekspencer)
-[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
+[![HACS Custom](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
+
+![Downloads](https://img.shields.io/github/downloads/natekspencer/hacs-oasis_mini/total?style=flat-square)
+![Latest Downloads](https://img.shields.io/github/downloads/natekspencer/hacs-oasis_mini/latest/total?style=flat-square)
 
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://brands.home-assistant.io/oasis_mini/dark_logo.png">

custom_components/oasis_mini/__init__.py

@@ -7,7 +7,8 @@ import logging
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.exceptions import ConfigEntryError, ConfigEntryNotReady
+import homeassistant.helpers.device_registry as dr
 
 from .const import DOMAIN
 from .coordinator import OasisMiniCoordinator
@@ -39,10 +40,28 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     except Exception as ex:
         _LOGGER.exception(ex)
 
+    if not entry.unique_id:
+        if not (serial_number := coordinator.device.serial_number):
+            dev_reg = dr.async_get(hass)
+            devices = dr.async_entries_for_config_entry(dev_reg, entry.entry_id)
+            serial_number = next(
+                (
+                    identifier[1]
+                    for identifier in devices[0].identifiers
+                    if identifier[0] == DOMAIN
+                ),
+                None,
+            )
+        hass.config_entries.async_update_entry(entry, unique_id=serial_number)
+
     if not coordinator.data:
         await client.session.close()
         raise ConfigEntryNotReady
 
+    if entry.unique_id != coordinator.device.serial_number:
+        await client.session.close()
+        raise ConfigEntryError("Serial number mismatch")
+
     hass.data[DOMAIN][entry.entry_id] = coordinator
 
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)

custom_components/oasis_mini/button.py

@@ -19,6 +19,7 @@ from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from .const import DOMAIN
 from .coordinator import OasisMiniCoordinator
 from .entity import OasisMiniEntity
+from .helpers import add_and_play_track
 from .pyoasismini import OasisMini
 from .pyoasismini.const import TRACKS
 
@@ -38,18 +39,8 @@ async def async_setup_entry(
 
 async def play_random_track(device: OasisMini) -> None:
     """Play random track."""
-    track = int(random.choice(list(TRACKS)))
-    if track not in device.playlist:
-        await device.async_add_track_to_playlist(track)
-
-    # Move track to next item in the playlist and then select it
-    if (index := device.playlist.index(track)) != device.playlist_index:
-        if index != (next_index := device.playlist_index + 1):
-            await device.async_move_track(index, next_index)
-        await device.async_change_track(next_index)
-
-    if device.status_code != 4:
-        await device.async_play()
+    track = random.choice(list(TRACKS))
+    await add_and_play_track(device, track)
 
 
 @dataclass(frozen=True, kw_only=True)

custom_components/oasis_mini/config_flow.py

@@ -10,6 +10,7 @@ from aiohttp import ClientConnectorError
 from httpx import ConnectError, HTTPStatusError
 import voluptuous as vol
 
+from homeassistant.components import dhcp
 from homeassistant.config_entries import ConfigEntry, ConfigFlow, ConfigFlowResult
 from homeassistant.const import CONF_ACCESS_TOKEN, CONF_EMAIL, CONF_HOST, CONF_PASSWORD
 from homeassistant.core import callback
@@ -63,28 +64,30 @@ class OasisMiniConfigFlow(ConfigFlow, domain=DOMAIN):
 
     VERSION = 1
 
-    host: str | None = None
-    serial_number: str | None = None
-
     @staticmethod
     @callback
     def async_get_options_flow(config_entry: ConfigEntry) -> SchemaOptionsFlowHandler:
         """Get the options flow for this handler."""
         return SchemaOptionsFlowHandler(config_entry, OPTIONS_FLOW)
 
-    # async def async_step_dhcp(self, discovery_info: dhcp.DhcpServiceInfo) -> ConfigFlowResult:
-    #     """Handle dhcp discovery."""
-    #     self.host = discovery_info.ip
-    #     self.name = discovery_info.hostname
-    #     await self.async_set_unique_id(discovery_info.macaddress)
-    #     self._abort_if_unique_id_configured(updates={CONF_HOST: self.host})
-    #     return await self.async_step_api_key()
+    async def async_step_dhcp(
+        self, discovery_info: dhcp.DhcpServiceInfo
+    ) -> ConfigFlowResult:
+        """Handle DHCP discovery."""
+        host = {CONF_HOST: discovery_info.ip}
+        await self.validate_client(host)
+        self._abort_if_unique_id_configured(updates=host)
+        # This should never happen since we only listen to DHCP requests
+        # for configured devices.
+        return self.async_abort(reason="already_configured")
 
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle the initial step."""
-        return await self._async_step("user", STEP_USER_DATA_SCHEMA, user_input)
+        return await self._async_step(
+            "user", STEP_USER_DATA_SCHEMA, user_input, user_input
+        )
 
     async def async_step_reconfigure(
         self, user_input: dict[str, Any] | None = None
@@ -106,26 +109,24 @@ class OasisMiniConfigFlow(ConfigFlow, domain=DOMAIN):
         suggested_values: dict[str, Any] | None = None,
     ) -> ConfigFlowResult:
         """Handle step setup."""
-        if abort := self._abort_if_configured(user_input):
-            return abort
-
         errors = {}
 
         if user_input is not None:
             if not (errors := await self.validate_client(user_input)):
-                data = {CONF_HOST: user_input.get(CONF_HOST, self.host)}
+                if step_id != "reconfigure":
+                    self._abort_if_unique_id_configured(updates=user_input)
                 if existing_entry := self.hass.config_entries.async_get_entry(
                     self.context.get("entry_id")
                 ):
                     self.hass.config_entries.async_update_entry(
-                        existing_entry, data=data
+                        existing_entry, data=user_input
                     )
                     await self.hass.config_entries.async_reload(existing_entry.entry_id)
                     return self.async_abort(reason="reconfigure_successful")
 
                 return self.async_create_entry(
-                    title=f"Oasis Mini {self.serial_number}",
-                    data=data,
+                    title=f"Oasis Mini {self.unique_id}",
+                    data=user_input,
                 )
 
         return self.async_show_form(
@@ -139,9 +140,9 @@ class OasisMiniConfigFlow(ConfigFlow, domain=DOMAIN):
         errors = {}
         try:
             async with asyncio.timeout(10):
-                client = create_client({"host": self.host} | user_input)
-                self.serial_number = await client.async_get_serial_number()
-            if not self.serial_number:
+                client = create_client(user_input)
+                await self.async_set_unique_id(await client.async_get_serial_number())
+            if not self.unique_id:
                 errors["base"] = "invalid_host"
         except asyncio.TimeoutError:
             errors["base"] = "timeout_connect"
@@ -157,15 +158,3 @@ class OasisMiniConfigFlow(ConfigFlow, domain=DOMAIN):
         finally:
             await client.session.close()
         return errors
-
-    @callback
-    def _abort_if_configured(
-        self, user_input: dict[str, Any] | None
-    ) -> ConfigFlowResult | None:
-        """Abort if configured."""
-        if self.host or user_input:
-            data = {CONF_HOST: self.host, **(user_input or {})}
-            for entry in self._async_current_entries():
-                if entry.data[CONF_HOST] == data[CONF_HOST]:
-                    return self.async_abort(reason="already_configured")
-        return None

custom_components/oasis_mini/coordinator.py

@@ -8,7 +8,6 @@ import logging
 import async_timeout
 
 from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import ConfigEntryAuthFailed
 from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import DOMAIN
@@ -20,16 +19,25 @@ _LOGGER = logging.getLogger(__name__)
 class OasisMiniCoordinator(DataUpdateCoordinator[str]):
     """Oasis Mini data update coordinator."""
 
+    attempt: int = 0
     last_updated: datetime | None = None
 
     def __init__(self, hass: HomeAssistant, device: OasisMini) -> None:
         """Initialize."""
         super().__init__(
-            hass, _LOGGER, name=DOMAIN, update_interval=timedelta(seconds=10)
+            hass,
+            _LOGGER,
+            name=DOMAIN,
+            update_interval=timedelta(seconds=10),
+            always_update=False,
         )
         self.device = device
 
     async def _async_update_data(self):
+        """Update the data."""
+        data: str | None = None
+        self.attempt += 1
+
         try:
             async with async_timeout.timeout(10):
                 if not self.device.mac_address:
@@ -39,11 +47,15 @@ class OasisMiniCoordinator(DataUpdateCoordinator[str]):
                 if not self.device.software_version:
                     await self.device.async_get_software_version()
                 data = await self.device.async_get_status()
+                self.attempt = 0
                 await self.device.async_get_current_track_details()
-        except Exception as ex:
-            raise UpdateFailed("Couldn't read from the Oasis Mini") from ex
-        if data is None:
-            raise ConfigEntryAuthFailed
+                await self.device.async_get_playlist_details()
+        except Exception as ex:  # pylint:disable=broad-except
+            if self.attempt > 2 or not (data or self.data):
+                raise UpdateFailed(
+                    f"Couldn't read from the Oasis Mini after {self.attempt} attempts"
+                ) from ex
+
         if data != self.data:
             self.last_updated = datetime.now()
         return data

custom_components/oasis_mini/helpers.py

@@ -12,3 +12,18 @@ from .pyoasismini import OasisMini
 def create_client(data: dict[str, Any]) -> OasisMini:
     """Create a Oasis Mini local client."""
     return OasisMini(data[CONF_HOST], data.get(CONF_ACCESS_TOKEN))
+
+
+async def add_and_play_track(device: OasisMini, track: int) -> None:
+    """Add and play a track."""
+    if track not in device.playlist:
+        await device.async_add_track_to_playlist(track)
+
+    # Move track to next item in the playlist and then select it
+    if (index := device.playlist.index(track)) != device.playlist_index:
+        if index != (_next := min(device.playlist_index + 1, len(device.playlist) - 1)):
+            await device.async_move_track(index, _next)
+        await device.async_change_track(_next)
+
+    if device.status_code != 4:
+        await device.async_play()

custom_components/oasis_mini/image.py

@@ -2,16 +2,16 @@
 
 from __future__ import annotations
 
-from datetime import datetime
-
-from homeassistant.components.image import ImageEntity, ImageEntityDescription
+from homeassistant.components.image import Image, ImageEntity, ImageEntityDescription
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import UNDEFINED
 
 from .const import DOMAIN
 from .coordinator import OasisMiniCoordinator
 from .entity import OasisMiniEntity
+from .pyoasismini.const import TRACKS
 from .pyoasismini.utils import draw_svg
 
 IMAGE = ImageEntityDescription(key="image", name=None)
@@ -21,6 +21,8 @@ class OasisMiniImageEntity(OasisMiniEntity, ImageEntity):
     """Oasis Mini image entity."""
 
     _attr_content_type = "image/svg+xml"
+    _track_id: int | None = None
+    _progress: int = 0
 
     def __init__(
         self,
@@ -31,15 +33,40 @@ class OasisMiniImageEntity(OasisMiniEntity, ImageEntity):
         """Initialize the entity."""
         super().__init__(coordinator, entry_id, description)
         ImageEntity.__init__(self, coordinator.hass)
-
-    @property
-    def image_last_updated(self) -> datetime | None:
-        """The time when the image was last updated."""
-        return self.coordinator.last_updated
+        self._handle_coordinator_update()
 
     def image(self) -> bytes | None:
         """Return bytes of image."""
-        return draw_svg(self.device.track, self.device.progress, "1")
+        if not self._cached_image:
+            self._cached_image = Image(
+                self.content_type, draw_svg(self.device.track, self._progress, "1")
+            )
+        return self._cached_image.content
+
+    @callback
+    def _handle_coordinator_update(self) -> None:
+        """Handle updated data from the coordinator."""
+        if self._track_id != self.device.track_id or (
+            self._progress != self.device.progress and self.device.access_token
+        ):
+            self._attr_image_last_updated = self.coordinator.last_updated
+            self._track_id = self.device.track_id
+            self._progress = self.device.progress
+            self._cached_image = None
+            if self.device.track and self.device.track.get("svg_content"):
+                self._attr_image_url = UNDEFINED
+            else:
+                self._attr_image_url = (
+                    f"https://app.grounded.so/uploads/{track['image']}"
+                    if (
+                        track := (self.device.track or TRACKS.get(self.device.track_id))
+                    )
+                    and "image" in track
+                    else None
+                )
+
+        if self.hass:
+            super()._handle_coordinator_update()
 
 
 async def async_setup_entry(
@@ -47,5 +74,4 @@ async def async_setup_entry(
 ) -> None:
     """Set up Oasis Mini camera using config entry."""
     coordinator: OasisMiniCoordinator = hass.data[DOMAIN][entry.entry_id]
-    if coordinator.device.access_token:
-        async_add_entities([OasisMiniImageEntity(coordinator, entry, IMAGE)])
+    async_add_entities([OasisMiniImageEntity(coordinator, entry, IMAGE)])

custom_components/oasis_mini/manifest.json

@@ -3,6 +3,7 @@
   "name": "Oasis Mini",
   "codeowners": ["@natekspencer"],
   "config_flow": true,
+  "dhcp": [{ "registered_devices": true }],
   "documentation": "https://github.com/natekspencer/hacs-oasis_mini",
   "integration_type": "device",
   "iot_class": "local_polling",

custom_components/oasis_mini/media_player.py

@@ -3,9 +3,11 @@
 from __future__ import annotations
 
 from datetime import datetime
-import math
+import logging
+from typing import Any
 
 from homeassistant.components.media_player import (
+    MediaPlayerEnqueue,
     MediaPlayerEntity,
     MediaPlayerEntityDescription,
     MediaPlayerEntityFeature,
@@ -15,6 +17,7 @@ from homeassistant.components.media_player import (
 )
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
+from homeassistant.exceptions import ServiceValidationError
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN
@@ -22,6 +25,8 @@ from .coordinator import OasisMiniCoordinator
 from .entity import OasisMiniEntity
 from .pyoasismini.const import TRACKS
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
     """Oasis Mini media player entity."""
@@ -33,6 +38,8 @@ class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
         | MediaPlayerEntityFeature.STOP
         | MediaPlayerEntityFeature.PREVIOUS_TRACK
         | MediaPlayerEntityFeature.NEXT_TRACK
+        | MediaPlayerEntityFeature.PLAY_MEDIA
+        | MediaPlayerEntityFeature.MEDIA_ENQUEUE
         | MediaPlayerEntityFeature.CLEAR_PLAYLIST
         | MediaPlayerEntityFeature.REPEAT_SET
     )
@@ -43,17 +50,17 @@ class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
         return MediaType.IMAGE
 
     @property
-    def media_duration(self) -> int:
+    def media_duration(self) -> int | None:
         """Duration of current playing media in seconds."""
         if (track := self.device.track) and "reduced_svg_content" in track:
             return track["reduced_svg_content"].get("1")
-        return math.ceil(self.media_position / 0.99)
+        return None
 
     @property
     def media_image_url(self) -> str | None:
         """Image url of current playing media."""
         if not (track := self.device.track):
-            track = TRACKS.get(str(self.device.track_id))
+            track = TRACKS.get(self.device.track_id)
         if track and "image" in track:
             return f"https://app.grounded.so/uploads/{track['image']}"
         return None
@@ -69,10 +76,12 @@ class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
         return self.coordinator.last_updated
 
     @property
-    def media_title(self) -> str:
+    def media_title(self) -> str | None:
         """Title of current playing media."""
+        if not self.device.track_id:
+            return None
         if not (track := self.device.track):
-            track = TRACKS.get(str(self.device.track_id), {})
+            track = TRACKS.get(self.device.track_id, {})
         return track.get("name", f"Unknown Title (#{self.device.track_id})")
 
     @property
@@ -84,11 +93,11 @@ class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
     def state(self) -> MediaPlayerState:
         """State of the player."""
         status_code = self.device.status_code
-        if self.device.error or status_code == 9:
+        if self.device.error or status_code in (9, 11):
             return MediaPlayerState.OFF
         if status_code == 2:
             return MediaPlayerState.IDLE
-        if status_code in (3, 11, 13):
+        if status_code in (3, 13):
             return MediaPlayerState.BUFFERING
         if status_code == 4:
             return MediaPlayerState.PLAYING
@@ -135,9 +144,56 @@ class OasisMiniMediaPlayerEntity(OasisMiniEntity, MediaPlayerEntity):
         await self.device.async_change_track(index)
         await self.coordinator.async_request_refresh()
 
+    async def async_play_media(
+        self,
+        media_type: MediaType | str,
+        media_id: str,
+        enqueue: MediaPlayerEnqueue | None = None,
+        **kwargs: Any,
+    ) -> None:
+        """Play a piece of media."""
+        if media_id not in map(str, TRACKS):
+            media_id = next(
+                (
+                    id
+                    for id, info in TRACKS.items()
+                    if info["name"].lower() == media_id.lower()
+                ),
+                media_id,
+            )
+        try:
+            track = int(media_id)
+        except ValueError as err:
+            raise ServiceValidationError(f"Invalid media: {media_id}") from err
+
+        device = self.device
+        enqueue = MediaPlayerEnqueue.NEXT if not enqueue else enqueue
+        if enqueue == MediaPlayerEnqueue.REPLACE:
+            await device.async_set_playlist([track])
+        else:
+            await device.async_add_track_to_playlist(track)
+
+        if enqueue in (MediaPlayerEnqueue.NEXT, MediaPlayerEnqueue.PLAY):
+            # Move track to next item in the playlist
+            if (index := (len(device.playlist) - 1)) != device.playlist_index:
+                if index != (
+                    _next := min(device.playlist_index + 1, len(device.playlist) - 1)
+                ):
+                    await device.async_move_track(index, _next)
+                if enqueue == MediaPlayerEnqueue.PLAY:
+                    await device.async_change_track(_next)
+
+        if (
+            enqueue in (MediaPlayerEnqueue.PLAY, MediaPlayerEnqueue.REPLACE)
+            and device.status_code != 4
+        ):
+            await device.async_play()
+
+        await self.coordinator.async_request_refresh()
+
     async def async_clear_playlist(self) -> None:
         """Clear players playlist."""
-        await self.device.async_set_playlist([0])
+        await self.device.async_clear_playlist()
         await self.coordinator.async_request_refresh()
 
 

custom_components/oasis_mini/number.py

@@ -2,7 +2,11 @@
 
 from __future__ import annotations
 
-from homeassistant.components.number import NumberEntity, NumberEntityDescription
+from homeassistant.components.number import (
+    NumberEntity,
+    NumberEntityDescription,
+    NumberMode,
+)
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
@@ -34,12 +38,14 @@ DESCRIPTORS = {
     NumberEntityDescription(
         key="ball_speed",
         name="Ball speed",
+        mode=NumberMode.SLIDER,
         native_max_value=BALL_SPEED_MAX,
         native_min_value=BALL_SPEED_MIN,
     ),
     NumberEntityDescription(
         key="led_speed",
         name="LED speed",
+        mode=NumberMode.SLIDER,
         native_max_value=LED_SPEED_MAX,
         native_min_value=LED_SPEED_MIN,
     ),

custom_components/oasis_mini/pyoasismini/__init__.py

@@ -5,8 +5,9 @@ import logging
 from typing import Any, Awaitable, Callable, Final
 from urllib.parse import urljoin
 
-from aiohttp import ClientSession
+from aiohttp import ClientResponseError, ClientSession
 
+from .const import TRACKS
 from .utils import _bit_to_bool
 
 _LOGGER = logging.getLogger(__name__)
@@ -15,12 +16,12 @@ STATUS_CODE_MAP = {
     0: "booting",  # maybe?
     2: "stopped",
     3: "centering",
-    4: "running",
+    4: "playing",
     5: "paused",
     9: "error",
     11: "updating",
     13: "downloading",
-    15: "live drawing",
+    15: "live",
 }
 
 AUTOPLAY_MAP = {
@@ -35,7 +36,7 @@ ATTRIBUTES: Final[list[tuple[str, Callable[[str], Any]]]] = [
     ("status_code", int),  # see status code map
     ("error", int),  # error, 0 = none, and 10 = ?, 18 = can't download?
     ("ball_speed", int),  # 200 - 1000
-    ("playlist", lambda value: [int(track) for track in value.split(",")]),  # noqa: E501 # comma separated track ids
+    ("playlist", lambda value: [int(track) for track in value.split(",") if track]),  # noqa: E501 # comma separated track ids
     ("playlist_index", int),  # index of above
     ("progress", int),  # 0 - max svg path
     ("led_effect", str),  # led effect (code lookup)
@@ -83,12 +84,14 @@ class OasisMini:
     _access_token: str | None = None
     _mac_address: str | None = None
     _ip_address: str | None = None
+    _playlist: dict[int, dict[str, str]] = {}
     _serial_number: str | None = None
     _software_version: str | None = None
     _track: dict | None = None
 
     autoplay: str
     brightness: int
+    busy: bool
     color: str
     download_progress: int
     error: int
@@ -122,6 +125,16 @@ class OasisMini:
         """Return the mac address."""
         return self._mac_address
 
+    @property
+    def drawing_progress(self) -> float | None:
+        """Return the drawing progress percent."""
+        if not (self.track and (svg_content := self.track.get("svg_content"))):
+            return None
+        paths = svg_content.split("L")
+        total = self.track.get("reduced_svg_content", {}).get("1", len(paths))
+        percent = (100 * self.progress) / total
+        return percent
+
     @property
     def serial_number(self) -> str | None:
         """Return the serial number."""
@@ -150,8 +163,10 @@ class OasisMini:
         return None
 
     @property
-    def track_id(self) -> int:
+    def track_id(self) -> int | None:
         """Return the current track id."""
+        if not self.playlist:
+            return None
         i = self.playlist_index
         return self.playlist[0] if i >= len(self.playlist) else self.playlist[i]
 
@@ -162,12 +177,15 @@ class OasisMini:
 
     async def async_add_track_to_playlist(self, track: int) -> None:
         """Add track to playlist."""
+        if not track:
+            return
+
         if 0 in self.playlist:
             playlist = [t for t in self.playlist if t] + [track]
-            await self.async_set_playlist(playlist)
-        else:
-            await self._async_command(params={"ADDJOBLIST": track})
-            self.playlist.append(track)
+            return await self.async_set_playlist(playlist)
+
+        await self._async_command(params={"ADDJOBLIST": track})
+        self.playlist.append(track)
 
     async def async_change_track(self, index: int) -> None:
         """Change the track."""
@@ -175,6 +193,10 @@ class OasisMini:
             raise ValueError("Invalid index specified")
         await self._async_command(params={"CMDCHANGETRACK": index})
 
+    async def async_clear_playlist(self) -> None:
+        """Clear the playlist."""
+        await self.async_set_playlist([])
+
     async def async_get_ip_address(self) -> str | None:
         """Get the ip address."""
         self._ip_address = await self._async_get(params={"GETIP": ""})
@@ -199,7 +221,7 @@ class OasisMini:
         _LOGGER.debug("Software version: %s", self._software_version)
         return self._software_version
 
-    async def async_get_status(self) -> None:
+    async def async_get_status(self) -> str:
         """Get the status from the device."""
         status = await self._async_get(params={"GETSTATUS": ""})
         _LOGGER.debug("Status: %s", status)
@@ -222,7 +244,8 @@ class OasisMini:
         """Send play command."""
         if self.status_code == 15:
             await self.async_stop()
-        await self._async_command(params={"CMDPLAY": ""})
+        if self.track_id:
+            await self._async_command(params={"CMDPLAY": ""})
 
     async def async_reboot(self) -> None:
         """Send reboot command."""
@@ -281,9 +304,13 @@ class OasisMini:
         await self._async_command(params={"WRIWAITAFTER": option})
 
     async def async_set_playlist(self, playlist: list[int]) -> None:
-        """Set playlist."""
+        """Set the playlist."""
+        if is_playing := (self.status_code == 4):
+            await self.async_stop()
         await self._async_command(params={"WRIJOBLIST": ",".join(map(str, playlist))})
         self.playlist = playlist
+        if is_playing:
+            await self.async_play()
 
     async def async_set_repeat_playlist(self, repeat: bool) -> None:
         """Set repeat playlist."""
@@ -310,31 +337,68 @@ class OasisMini:
         """Login via the cloud."""
         await self._async_cloud_request("GET", "api/auth/logout")
 
-    async def async_cloud_get_track_info(self, track_id: int) -> dict[str, Any]:
+    async def async_cloud_get_track_info(self, track_id: int) -> dict[str, Any] | None:
         """Get cloud track info."""
-        return await self._async_cloud_request("GET", f"api/track/{track_id}")
+        try:
+            return await self._async_cloud_request("GET", f"api/track/{track_id}")
+        except ClientResponseError as err:
+            if err.status == 404:
+                return {"id": track_id, "name": f"Unknown Title (#{track_id})"}
+        except Exception as ex:
+            _LOGGER.exception(ex)
+        return None
 
-    async def async_cloud_get_tracks(self, tracks: list[int]) -> dict:
+    async def async_cloud_get_tracks(
+        self, tracks: list[int] | None = None
+    ) -> list[dict[str, Any]]:
         """Get tracks info from the cloud"""
-        return await self._async_cloud_request(
-            "GET", "api/track", params={"ids[]": tracks}
+        response = await self._async_cloud_request(
+            "GET", "api/track", params={"ids[]": tracks or []}
         )
+        if not response:
+            return None
+        track_details = response.get("data", [])
+        while next_page_url := response.get("next_page_url"):
+            response = await self._async_cloud_request("GET", next_page_url)
+            track_details += response.get("data", [])
+        return track_details
 
     async def async_cloud_get_latest_software_details(self) -> dict[str, int | str]:
         """Get the latest software details from the cloud."""
         return await self._async_cloud_request("GET", "api/software/last-version")
 
-    async def async_get_current_track_details(self) -> dict:
+    async def async_get_current_track_details(self) -> dict | None:
         """Get current track info, refreshing if needed."""
-        if (track := self._track) and track.get("id") == self.track_id:
+        track_id = self.track_id
+        if (track := self._track) and track.get("id") == track_id:
             return track
-        if self.track_id:
-            self._track = await self.async_cloud_get_track_info(self.track_id)
+        if track_id:
+            self._track = await self.async_cloud_get_track_info(track_id)
+            if not self._track:
+                self._track = TRACKS.get(
+                    track_id, {"id": track_id, "name": f"Unknown Title (#{track_id})"}
+                )
         return self._track
 
-    async def async_get_playlist_details(self) -> dict:
+    async def async_get_playlist_details(self) -> dict[int, dict[str, str]]:
         """Get playlist info."""
-        return await self.async_cloud_get_tracks(self.playlist)
+        if set(self.playlist).difference(self._playlist.keys()):
+            tracks = await self.async_cloud_get_tracks(self.playlist)
+            all_tracks = TRACKS | {
+                track["id"]: {
+                    "name": track["name"],
+                    "author": ((track.get("author") or {}).get("person") or {}).get(
+                        "name", "Oasis Mini"
+                    ),
+                    "image": track["image"],
+                }
+                for track in tracks
+            }
+            for track in self.playlist:
+                self._playlist[track] = all_tracks.get(
+                    track, {"name": f"Unknown Title (#{track})"}
+                )
+        return self._playlist
 
     async def _async_cloud_request(self, method: str, url: str, **kwargs: Any) -> Any:
         """Perform a cloud request."""
@@ -359,6 +423,13 @@ class OasisMini:
 
     async def _async_request(self, method: str, url: str, **kwargs) -> Any:
         """Perform a request."""
+        _LOGGER.debug(
+            "%s %s",
+            method,
+            self._session._build_url(url).update_query(  # pylint: disable=protected-access
+                kwargs.get("params")
+            ),
+        )
         response = await self._session.request(method, url, **kwargs)
         if response.status == 200:
             if response.content_type == "application/json":

custom_components/oasis_mini/pyoasismini/const.py

@@ -4,8 +4,13 @@ from __future__ import annotations
 
 import json
 import os
-from typing import Final
+from typing import Any, Final
 
 __TRACKS_FILE = os.path.join(os.path.dirname(__file__), "tracks.json")
-with open(__TRACKS_FILE, "r", encoding="utf8") as file:
-    TRACKS: Final[dict[str, dict[str, str]]] = json.load(file)
+try:
+    with open(__TRACKS_FILE, "r", encoding="utf8") as file:
+        TRACKS: Final[dict[int, dict[str, Any]]] = {
+            int(k): v for k, v in json.load(file).items()
+        }
+except Exception:  # ignore: broad-except
+    TRACKS = {}

custom_components/oasis_mini/pyoasismini/utils.py

@@ -27,8 +27,8 @@ def draw_svg(track: dict, progress: int, model_id: str) -> str | None:
             if progress is not None:
                 paths = svg_content.split("L")
                 total = track.get("reduced_svg_content", {}).get(model_id, len(paths))
-                percent = (100 * progress) / total
-                progress = math.floor((percent / 100) * len(paths))
+                percent = min((100 * progress) / total, 100)
+                progress = math.floor((percent / 100) * (len(paths) - 1))
 
                 svg = Element(
                     "svg",

custom_components/oasis_mini/select.py

@@ -7,7 +7,7 @@ from typing import Any, Awaitable, Callable
 
 from homeassistant.components.select import SelectEntity, SelectEntityDescription
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.core import HomeAssistant
+from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity import EntityDescription
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
@@ -22,6 +22,7 @@ from .pyoasismini.const import TRACKS
 class OasisMiniSelectEntityDescription(SelectEntityDescription):
     """Oasis Mini select entity description."""
 
+    current_value: Callable[[OasisMini], Any]
     select_fn: Callable[[OasisMini, int], Awaitable[None]]
     update_handler: Callable[[OasisMiniSelectEntity], None] | None = None
 
@@ -30,6 +31,7 @@ class OasisMiniSelectEntity(OasisMiniEntity, SelectEntity):
     """Oasis Mini select entity."""
 
     entity_description: OasisMiniSelectEntityDescription
+    _current_value: Any | None = None
 
     def __init__(
         self,
@@ -46,8 +48,13 @@ class OasisMiniSelectEntity(OasisMiniEntity, SelectEntity):
         await self.entity_description.select_fn(self.device, self.options.index(option))
         await self.coordinator.async_request_refresh()
 
+    @callback
     def _handle_coordinator_update(self) -> None:
         """Handle updated data from the coordinator."""
+        new_value = self.entity_description.current_value(self.device)
+        if self._current_value == new_value:
+            return
+        self._current_value = new_value
         if update_handler := self.entity_description.update_handler:
             update_handler(self)
         else:
@@ -61,19 +68,29 @@ class OasisMiniSelectEntity(OasisMiniEntity, SelectEntity):
 def playlist_update_handler(entity: OasisMiniSelectEntity) -> None:
     """Handle playlist updates."""
     # pylint: disable=protected-access
+    device = entity.device
     options = [
-        TRACKS.get(str(track), {}).get("name", str(track))
-        for track in entity.device.playlist
+        device._playlist.get(track, {}).get(
+            "name",
+            TRACKS.get(track, {"id": track, "name": f"Unknown Title (#{track})"}).get(
+                "name",
+                device.track["name"]
+                if device.track and device.track["id"] == track
+                else str(track),
+            ),
+        )
+        for track in device.playlist
     ]
     entity._attr_options = options
-    index = min(entity.device.playlist_index, len(options) - 1)
-    entity._attr_current_option = options[index]
+    index = min(device.playlist_index, len(options) - 1)
+    entity._attr_current_option = options[index] if options else None
 
 
 DESCRIPTORS = (
     OasisMiniSelectEntityDescription(
         key="playlist",
         name="Playlist",
+        current_value=lambda device: (device.playlist.copy(), device.playlist_index),
         select_fn=lambda device, option: device.async_change_track(option),
         update_handler=playlist_update_handler,
     ),
@@ -81,6 +98,7 @@ DESCRIPTORS = (
         key="autoplay",
         name="Autoplay",
         options=list(AUTOPLAY_MAP.values()),
+        current_value=lambda device: device.autoplay,
         select_fn=lambda device, option: device.async_set_autoplay(option),
     ),
 )

custom_components/oasis_mini/sensor.py

@@ -22,12 +22,18 @@ async def async_setup_entry(
 ) -> None:
     """Set up Oasis Mini sensors using config entry."""
     coordinator: OasisMiniCoordinator = hass.data[DOMAIN][entry.entry_id]
-    async_add_entities(
-        [
-            OasisMiniSensorEntity(coordinator, entry, descriptor)
-            for descriptor in DESCRIPTORS
-        ]
-    )
+    entities = [
+        OasisMiniSensorEntity(coordinator, entry, descriptor)
+        for descriptor in DESCRIPTORS
+    ]
+    if coordinator.device.access_token:
+        entities.extend(
+            [
+                OasisMiniSensorEntity(coordinator, entry, descriptor)
+                for descriptor in CLOUD_DESCRIPTORS
+            ]
+        )
+    async_add_entities(entities)
 
 
 DESCRIPTORS = {
@@ -43,6 +49,7 @@ DESCRIPTORS = {
     SensorEntityDescription(
         key=key,
         name=key.replace("_", " ").capitalize(),
+        translation_key=key,
         entity_category=EntityCategory.DIAGNOSTIC,
         entity_registry_enabled_default=False,
     )
@@ -55,6 +62,17 @@ DESCRIPTORS = {
     )
 }
 
+CLOUD_DESCRIPTORS = (
+    SensorEntityDescription(
+        key="drawing_progress",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        name="Drawing progress",
+        native_unit_of_measurement=PERCENTAGE,
+        state_class=SensorStateClass.MEASUREMENT,
+        suggested_display_precision=1,
+    ),
+)
+
 
 class OasisMiniSensorEntity(OasisMiniEntity, SensorEntity):
     """Oasis Mini sensor entity."""

custom_components/oasis_mini/strings.json

@@ -10,9 +10,6 @@
         "data": {
           "host": "[%key:common::config_flow::data::host%]"
         }
-      },
-      "reauth_confirm": {
-        "data": {}
       }
     },
     "error": {
@@ -23,13 +20,13 @@
     },
     "abort": {
       "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
-      "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]",
       "reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
     }
   },
   "options": {
     "step": {
       "init": {
+        "description": "Add your cloud credentials to get additional information about your device",
         "data": {
           "email": "[%key:common::config_flow::data::email%]",
           "password": "[%key:common::config_flow::data::password%]"
@@ -39,5 +36,23 @@
     "error": {
       "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]"
     }
+  },
+  "entity": {
+    "sensor": {
+      "status": {
+        "name": "Status",
+        "state": {
+          "booting": "Booting",
+          "stopped": "Stopped",
+          "centering": "Centering",
+          "playing": "Playing",
+          "paused": "Paused",
+          "error": "Error",
+          "updating": "Updating",
+          "downloading": "Downloading",
+          "live": "Live drawing"
+        }
+      }
+    }
   }
 }

custom_components/oasis_mini/translations/en.json

@@ -10,9 +10,6 @@
         "data": {
           "host": "Host"
         }
-      },
-      "reauth_confirm": {
-        "data": {}
       }
     },
     "error": {
@@ -23,13 +20,13 @@
     },
     "abort": {
       "already_configured": "Device is already configured",
-      "reauth_successful": "Re-authentication was successful",
       "reconfigure_successful": "Re-configuration was successful"
     }
   },
   "options": {
     "step": {
       "init": {
+        "description": "Add your cloud credentials to get additional information about your device",
         "data": {
           "email": "Email",
           "password": "Password"
@@ -39,5 +36,23 @@
     "error": {
       "invalid_auth": "Invalid authentication"
     }
+  },
+  "entity": {
+    "sensor": {
+      "status": {
+        "name": "Status",
+        "state": {
+          "booting": "Booting",
+          "stopped": "Stopped",
+          "centering": "Centering",
+          "playing": "Playing",
+          "paused": "Paused",
+          "error": "Error",
+          "updating": "Updating",
+          "downloading": "Downloading",
+          "live": "Live drawing"
+        }
+      }
+    }
   }
 }

custom_components/oasis_mini/update.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from datetime import timedelta
+import logging
 from typing import Any
 
 from homeassistant.components.update import (
@@ -19,6 +20,8 @@ from .const import DOMAIN
 from .coordinator import OasisMiniCoordinator
 from .entity import OasisMiniEntity
 
+_LOGGER = logging.getLogger(__name__)
+
 SCAN_INTERVAL = timedelta(hours=6)
 
 
@@ -66,11 +69,18 @@ class OasisMiniUpdateEntity(OasisMiniEntity, UpdateEntity):
         self, version: str | None, backup: bool, **kwargs: Any
     ) -> None:
         """Install an update."""
+        version = await self.device.async_get_software_version()
+        if version == self.latest_version:
+            return
         await self.device.async_upgrade()
 
     async def async_update(self) -> None:
         """Update the entity."""
+        await self.device.async_get_software_version()
         software = await self.device.async_cloud_get_latest_software_details()
+        if not software:
+            _LOGGER.warning("Unable to get latest software details")
+            return
         self._attr_latest_version = software["version"]
         self._attr_release_summary = software["description"]
         self._attr_release_url = f"https://app.grounded.so/software/{software['id']}"

requirements.txt

@@ -1,6 +1,5 @@
 # Home Assistant
 homeassistant>=2024.4
-home-assistant-frontend
 numpy
 PyTurboJPEG