init commit

custom_components/roborock_custom_map/__init__.py

@@ -0,0 +1,37 @@
+"""Roborock Custom Map integration."""
+
+from __future__ import annotations
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.config_entries import ConfigEntryState
+from homeassistant.exceptions import ConfigEntryNotReady
+
+PLATFORMS = [Platform.IMAGE]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up Roborock Custom map from a config entry."""
+    roborock_entries = hass.config_entries.async_entries("roborock")
+    coordinators = []
+
+    async def unload_this_entry():
+        await hass.config_entries.async_reload(entry.entry_id)
+
+    for r_entry in roborock_entries:
+        if r_entry.state == ConfigEntryState.LOADED:
+            coordinators.extend(r_entry.runtime_data.v1)
+            # If any unload, then we should reload as well in case there are major changes.
+            r_entry.async_on_unload(unload_this_entry)
+    if len(coordinators) == 0:
+        raise ConfigEntryNotReady("No Roborock entries loaded. Cannot start.")
+    entry.runtime_data = coordinators
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Unload a config entry."""
+    return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

custom_components/roborock_custom_map/config_flow.py

@@ -0,0 +1,24 @@
+"""Config flow for Roborock Custom Map integration."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant import config_entries
+from homeassistant.data_entry_flow import FlowResult
+
+from .const import DOMAIN
+
+
+class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Roborock Custom Map."""
+
+    VERSION = 1
+
+    async def async_step_user(
+        self, user_input: dict[str, Any] | None = None
+    ) -> FlowResult:
+        """Handle the initial step."""
+        self.async_set_unique_id(DOMAIN)
+        self._abort_if_unique_id_configured()
+        return self.async_create_entry(title="Roborock Custom Map", data={})

custom_components/roborock_custom_map/const.py

@@ -0,0 +1,3 @@
+"""Constants for Roborock Custom Map integration."""
+
+DOMAIN = "roborock_custom_map"

custom_components/roborock_custom_map/image.py

@@ -0,0 +1,104 @@
+"""Support for Roborock image."""
+
+from datetime import datetime
+import logging
+
+from homeassistant.components.image import ImageEntity
+from homeassistant.components.roborock.coordinator import RoborockDataUpdateCoordinator
+from homeassistant.components.roborock.entity import RoborockCoordinatedEntityV1
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+_LOGGER = logging.getLogger(__name__)
+
+PARALLEL_UPDATES = 0
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up Roborock image platform."""
+
+    async_add_entities(
+        (
+            RoborockMap(
+                config_entry,
+                f"{coord.duid_slug}_custom_map_{map_info.name}",
+                coord,
+                map_info.flag,
+                map_info.name,
+            )
+            for coord in config_entry.runtime_data
+            for map_info in coord.maps.values()
+        ),
+    )
+
+
+class RoborockMap(RoborockCoordinatedEntityV1, ImageEntity):
+    """A class to let you visualize the map."""
+
+    _attr_has_entity_name = True
+    image_last_updated: datetime
+    _attr_name: str
+
+    def __init__(
+        self,
+        config_entry: ConfigEntry,
+        unique_id: str,
+        coordinator: RoborockDataUpdateCoordinator,
+        map_flag: int,
+        map_name: str,
+    ) -> None:
+        """Initialize a Roborock map."""
+        RoborockCoordinatedEntityV1.__init__(self, unique_id, coordinator)
+        ImageEntity.__init__(self, coordinator.hass)
+        self.config_entry = config_entry
+        self._attr_name = map_name + "_custom"
+        self.map_flag = map_flag
+        self.cached_map = b""
+        self._attr_entity_category = EntityCategory.DIAGNOSTIC
+
+    @property
+    def is_selected(self) -> bool:
+        """Return if this map is the currently selected map."""
+        return self.map_flag == self.coordinator.current_map
+
+    async def async_added_to_hass(self) -> None:
+        """When entity is added to hass load any previously cached maps from disk."""
+        await super().async_added_to_hass()
+        self._attr_image_last_updated = self.coordinator.maps[
+            self.map_flag
+        ].last_updated
+        self.async_write_ha_state()
+
+    def _handle_coordinator_update(self) -> None:
+        # If the coordinator has updated the map, we can update the image.
+        self._attr_image_last_updated = self.coordinator.maps[
+            self.map_flag
+        ].last_updated
+
+        super()._handle_coordinator_update()
+
+    async def async_image(self) -> bytes | None:
+        """Get the cached image."""
+        return self.coordinator.maps[self.map_flag].image
+
+    @property
+    def extra_state_attributes(self):
+        map_data = self.coordinator.maps[self.map_flag].map_data
+        if map_data is None:
+            return {}
+        for room in map_data.rooms.values():
+            room.name = self.coordinator.maps[self.map_flag].rooms.get(room.number)
+
+        return {
+            "calibration_points": self.coordinator.maps[
+                self.map_flag
+            ].map_data.calibration(),
+            "rooms": map_data.rooms,
+            "zones": map_data.zones,
+        }

custom_components/roborock_custom_map/manifest.json

@@ -0,0 +1,13 @@
+{
+  "domain": "roborock_custom_map",
+  "name": "Roborock Custom Map",
+  "codeowners": ["@Lash-L"],
+  "config_flow": true,
+  "dependencies": ["roborock"],
+  "documentation": "https://github.com/Lash-L/RoborockCustomMap",
+  "iot_class": "local_polling",
+  "issue_tracker": "https://github.com/Lash-L/RoborockCustomMap/issues",
+  "requirements": [],
+
+  "version": "0.1.0"
+}

custom_components/roborock_custom_map/translations/en.json

@@ -0,0 +1,7 @@
+{
+  "config": {
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
+    }
+  }
+}