Basic functionality for ijai map acquisition and image rendering

.gitignore

@@ -149,4 +149,6 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-.idea/
+.idea/
+
+.vscode/

custom_components/xiaomi_cloud_map_extractor/camera.py

@@ -8,6 +8,8 @@
 from vacuum_map_parser_base.config.image_config import ImageConfig
 from vacuum_map_parser_base.config.size import Sizes
 from vacuum_map_parser_base.config.text import Text
+from vacuum_map_parser_base.image_generator import ImageGenerator
+from vacuum_map_parser_base.map_data import ImageData
 
 import PIL.Image as Image
 import voluptuous as vol
@@ -25,9 +27,12 @@
 from .vacuum_platforms.vacuum_roborock import RoborockCloudVacuum
 from .vacuum_platforms.vacuum_roidmi import RoidmiCloudVacuum
 from .vacuum_platforms.vacuum_viomi import ViomiCloudVacuum
+from .vacuum_platforms.vacuum_ijai import IjaiCloudVacuum
 from .vacuum_platforms.vacuum_unsupported import UnsupportedCloudVacuum
+from .initializer import from_dict
 from .const import *
 
+
 _LOGGER = logging.getLogger(__name__)
 
 SCAN_INTERVAL = timedelta(seconds=5)
@@ -119,25 +124,24 @@
         vol.Optional(CONF_FORCE_API, default=None): vol.Or(vol.In(CONF_AVAILABLE_APIS), vol.Equal(None))
     })
 
-
 async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
     await async_setup_reload_service(hass, DOMAIN, PLATFORMS)
-
+    _LOGGER.debug(f"config={config}")
     host = config[CONF_HOST]
     token = config[CONF_TOKEN]
     username = config[CONF_USERNAME]
     password = config[CONF_PASSWORD]
     country = config[CONF_COUNTRY]
     name = config[CONF_NAME]
     should_poll = config[CONF_AUTO_UPDATE]
-    image_config = config[CONF_MAP_TRANSFORM]
+    image_config = from_dict(ImageConfig, config[CONF_MAP_TRANSFORM])
     colors = config[CONF_COLORS]
     room_colors = config[CONF_ROOM_COLORS]
     for room, color in room_colors.items():
         colors[f"{COLOR_ROOM_PREFIX}{room}"] = color
     drawables = config[CONF_DRAW]
-    sizes = config[CONF_SIZES]
-    texts = config[CONF_TEXTS]
+    sizes = Sizes(config[CONF_SIZES])
+    texts = from_dict(list, config[CONF_TEXTS])
     if DRAWABLE_ALL in drawables:
         drawables = CONF_AVAILABLE_DRAWABLES[1:]
     attributes = config[CONF_ATTRIBUTES]
@@ -147,7 +151,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
     force_api = config[CONF_FORCE_API]
     entity_id = generate_entity_id(ENTITY_ID_FORMAT, name, hass=hass)
     async_add_entities([VacuumCamera(entity_id, host, token, username, password, country, name, should_poll,
-                                     image_config, colors, drawables, sizes, texts, attributes, store_map_raw,
+                                     image_config, ColorsPalette(colors, room_colors), drawables, sizes, texts, attributes, store_map_raw,
                                      store_map_image, store_map_path, force_api)])
 
 
@@ -228,6 +232,7 @@ def should_poll(self) -> bool:
 
     @staticmethod
     def extract_attributes(map_data: MapData, attributes_to_return: list[str], country) -> dict[str, any]:
+        _LOGGER.debug(f"extract_attributes{map_data}, {attributes_to_return}, country")
         attributes = {}
         rooms = []
         if map_data.rooms is not None:
@@ -269,16 +274,21 @@ def extract_attributes(map_data: MapData, attributes_to_return: list[str], count
     def update(self):
         if self._status != CameraStatus.TWO_FACTOR_AUTH_REQUIRED and not self._logged_in:
             self._login()
-        if self._device is None and self._logged_in:
-            self._initialize_device()
-        if self._logged_in and self._device is not None:
-            self._download_map_data()
-        else:
-            _LOGGER.debug("Unable to retrieve map, reasons: Logged in - %s, device retrieved - %s",
-                          self._logged_in, self._device is not None)
-            if self._device is not None:
-                self._set_map_data(self._device.map_data_parser.create_empty(str(self._status)))
-        self._logged_in_previously = self._logged_in
+        if self._device is not None:
+            if self._logged_in:
+                #if we're logged in and the device is initialized - retrieve, parse and render map
+                self._download_map_data()
+                self._render_map()
+                return
+            #if the device is up and login failed (?) initialize map data
+            self._map_data = MapData()
+            self._map_data.image = ImageData.create_empty(self._image_generator.create_empty_map_image(str(self._status)))
+            return
+        #apparently we should initialize the device in case we haven't done it before
+        self._initialize_device()
+
+#        _LOGGER.debug("Unable to retrieve map, reasons: Logged in - %s, device retrieved - %s",
+#                    self._logged_in, self._device is not None)
 
     def _login(self):
         _LOGGER.debug("Logging in...")
@@ -294,35 +304,44 @@ def _login(self):
             self._status = CameraStatus.FAILED_LOGIN
             if self._logged_in_previously:
                 _LOGGER.error("Unable to log in, check credentials")
+        self._logged_in_previously = self._logged_in
+
+    def _render_map(self):
+        if self._map_data is None or self._map_data.image is None or self._map_data.image.is_empty:
+            return
+        if not hasattr(self, "_image_generator") or self._image_generator is None:
+            self._image_generator = ImageGenerator(self._colors, self._sizes, self._device.map_data_parser._image_parser._drawables, self._image_config, self._texts)
+        self._image_generator.draw_map(self._map_data)
+        img_byte_arr = io.BytesIO()
+        self._map_data.image.data.save(img_byte_arr, format='PNG')
+        self._image = img_byte_arr.getvalue()
+        self._store_image()
 
     def _initialize_device(self):
         _LOGGER.debug("Retrieving device info, country: %s", self._country)
-        country, user_id, device_id, model = self._connector.get_device_details(self._token, self._country)
+        country, user_id, device_id, model, mac = self._connector.get_device_details(self._token, self._country)
         if model is not None:
             self._country = country
             _LOGGER.debug("Retrieved device model: %s", model)
-            self._device = self._create_device(user_id, device_id, model)
+            self._device = self._create_device(user_id, device_id, model, mac)
             _LOGGER.debug("Created device, used api: %s", self._used_api)
         else:
             _LOGGER.error("Failed to retrieve model")
             self._status = CameraStatus.FAILED_TO_RETRIEVE_DEVICE
 
     def _download_map_data(self):
         _LOGGER.debug("Retrieving map from Xiaomi cloud")
-        map_data, map_stored = self._device.get_map()
-        if map_data is not None:
+        self._map_data, map_stored = self._device.get_map()
+        if self._map_data is not None:
             # noinspection PyBroadException
             try:
                 _LOGGER.debug("Map data retrieved")
                 self._map_saved = map_stored
-                if map_data.image.is_empty:
+                if self._map_data.image.is_empty:
                     _LOGGER.debug("Map is empty")
                     self._status = CameraStatus.EMPTY_MAP
-                    if self._map_data is None or self._map_data.image.is_empty:
-                        self._set_map_data(map_data)
                 else:
                     _LOGGER.debug("Map is ok")
-                    self._set_map_data(map_data)
                     self._status = CameraStatus.OK
             except:
                 _LOGGER.warning("Unable to parse map data")
@@ -332,35 +351,31 @@ def _download_map_data(self):
             _LOGGER.warning("Unable to retrieve map data")
             self._status = CameraStatus.UNABLE_TO_RETRIEVE_MAP
 
-    def _set_map_data(self, map_data: MapData):
-        img_byte_arr = io.BytesIO()
-        map_data.image.data.save(img_byte_arr, format='PNG')
-        self._image = img_byte_arr.getvalue()
-        self._map_data = map_data
-        self._store_image()
-
-    def _create_device(self, user_id: str, device_id: str, model: str) -> XiaomiCloudVacuum:
+    def _create_device(self, user_id: str, device_id: str, model: str, mac: str) -> XiaomiCloudVacuum:
         self._used_api = self._detect_api(model)
         store_map_path = self._store_map_path if self._store_map_raw else None
         vacuum_config = VacuumConfig(
-            self._connector,
-            self._country,
-            user_id,
-            device_id,
-            self._host,
-            self._token,
-            model,
-            self._colors,
-            self._drawables,
-            self._image_config,
-            self._sizes,
-            self._texts,
-            store_map_path
+            connector=self._connector,
+            country=self._country,
+            user_id=user_id,
+            device_id=device_id,
+            host=self._host,
+            token=self._token,
+            model=model,
+            _mac=mac,
+            palette=self._colors,
+            drawables=self._drawables,
+            image_config=self._image_config,
+            sizes=self._sizes,
+            texts=self._texts,
+            store_map_path=store_map_path
         )
         if self._used_api == CONF_AVAILABLE_API_XIAOMI:
             return RoborockCloudVacuum(vacuum_config)
         if self._used_api == CONF_AVAILABLE_API_VIOMI:
             return ViomiCloudVacuum(vacuum_config)
+        if self._used_api == CONF_AVAILABLE_API_IJAI:
+            return IjaiCloudVacuum(vacuum_config)
         if self._used_api == CONF_AVAILABLE_API_ROIDMI:
             return RoidmiCloudVacuum(vacuum_config)
         if self._used_api == CONF_AVAILABLE_API_DREAME:
@@ -386,6 +401,7 @@ def _store_image(self):
             try:
                 image = Image.open(io.BytesIO(self._image))
                 image.save(f"{self._store_map_path}/map_image_{self._device.model}.png")
+                _LOGGER.debug(f"image path = {self._store_map_path}/map_image_{self._device.model}.png")
             except:
                 _LOGGER.warning("Error while saving image")
 

custom_components/xiaomi_cloud_map_extractor/const.py

@@ -6,6 +6,7 @@
 CONF_AVAILABLE_API_DREAME = "dreame"
 CONF_AVAILABLE_API_ROIDMI = "roidmi"
 CONF_AVAILABLE_API_VIOMI = "viomi"
+CONF_AVAILABLE_API_IJAI = "ijai"
 CONF_AVAILABLE_API_XIAOMI = "xiaomi"
 CONF_AVAILABLE_COUNTRIES = ["cn", "de", "us", "ru", "tw", "sg", "in", "i2"]
 CONF_BOTTOM = "bottom"
@@ -42,7 +43,7 @@
 CONF_Y = "y"
 
 CONF_AVAILABLE_APIS = [CONF_AVAILABLE_API_XIAOMI, CONF_AVAILABLE_API_VIOMI, CONF_AVAILABLE_API_ROIDMI,
-                       CONF_AVAILABLE_API_DREAME]
+                       CONF_AVAILABLE_API_DREAME, CONF_AVAILABLE_API_IJAI]
 
 CONF_AVAILABLE_SIZES = [CONF_SIZE_VACUUM_RADIUS, CONF_SIZE_PATH_WIDTH, CONF_SIZE_IGNORED_OBSTACLE_RADIUS,
                         CONF_SIZE_IGNORED_OBSTACLE_WITH_PHOTO_RADIUS, CONF_SIZE_MOP_PATH_WIDTH,
@@ -215,6 +216,7 @@
     CONF_AVAILABLE_API_DREAME: ["dreame.vacuum."],
     CONF_AVAILABLE_API_ROIDMI: ["roidmi.vacuum.", "zhimi.vacuum.", "chuangmi.vacuum."],
     CONF_AVAILABLE_API_VIOMI: ["viomi.vacuum."],
+    CONF_AVAILABLE_API_IJAI: ["ijai.vacuum."],
     CONF_AVAILABLE_API_XIAOMI: ["roborock.vacuum", "rockrobo.vacuum"]
 }
 

custom_components/xiaomi_cloud_map_extractor/initializer.py

@@ -0,0 +1,8 @@
+from dataclasses import fields
+
+def from_dict(cls, d):
+    try:
+        fieldtypes = {f.name: f.type for f in fields(cls)}
+        return cls(**{f: from_dict(fieldtypes[f], d[f]) for f in d})
+    except:
+        return d

custom_components/xiaomi_cloud_map_extractor/manifest.json

@@ -1,12 +1,13 @@
 {
   "domain": "xiaomi_cloud_map_extractor",
   "name": "Xiaomi Cloud Map Extractor",
-  "documentation": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor",
-  "issue_tracker": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor/issues",
-  "dependencies": [],
   "codeowners": [
     "@PiotrMachowski"
   ],
+  "dependencies": [],
+  "documentation": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor",
+  "iot_class": "cloud_polling",
+  "issue_tracker": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor/issues",
   "requirements": [
     "Pillow",
     "pybase64",
@@ -19,6 +20,5 @@
     "vacuum-map-parser-roidmi",
     "vacuum-map-parser-dreame"
   ],
-  "version": "v3.0.0-beta",
-  "iot_class": "cloud_polling"
+  "version": "v3.0.0-beta"
 }

custom_components/xiaomi_cloud_map_extractor/vacuum_platforms/vacuum_base.py

@@ -11,7 +11,6 @@
 
 from .xiaomi_cloud_connector import XiaomiCloudConnector
 
-
 @dataclass
 class VacuumConfig:
     connector: XiaomiCloudConnector
@@ -21,6 +20,7 @@ class VacuumConfig:
     host: str
     token: str
     model: str
+    _mac: str
     palette: ColorsPalette
     drawables: list[Drawable]
     image_config: ImageConfig

custom_components/xiaomi_cloud_map_extractor/vacuum_platforms/vacuum_ijai.py

@@ -0,0 +1,95 @@
+
+from vacuum_map_parser_ijai.map_data_parser import IjaiMapDataParser
+from miio.miot_device import MiotDevice
+
+from .vacuum_v2 import XiaomiCloudVacuumV2
+from .vacuum_base import VacuumConfig
+import logging
+_LOGGER = logging.getLogger(__name__)
+
+class IjaiCloudVacuum(XiaomiCloudVacuumV2):
+    WIFI_STR_LEN = 18
+
+    def __init__(self, vacuum_config: VacuumConfig):
+        super().__init__(vacuum_config)
+        self._token = vacuum_config.token
+        self._host = vacuum_config.host
+        self._mac = vacuum_config._mac
+        self._wifi_info_sn = None
+
+        self._ijai_map_data_parser = IjaiMapDataParser(
+            vacuum_config.palette,
+            vacuum_config.sizes,
+            vacuum_config.drawables,
+            vacuum_config.image_config,
+            vacuum_config.texts
+        )
+
+    @property
+    def map_archive_extension(self) -> str:
+        return "zlib"
+
+    @property
+    def map_data_parser(self) -> IjaiMapDataParser:
+        return self._ijai_map_data_parser
+
+    def get_map_url(self, map_name: str) -> str | None:
+        url = self._connector.get_api_url(self._country) + '/v2/home/get_interim_file_url_pro'
+        params = {
+            "data": f'{{"obj_name":"{self._user_id}/{self._device_id}/{map_name}"}}'
+        }
+        api_response = self._connector.execute_api_call_encrypted(url, params)
+        if api_response is None or ("result" not in api_response) or (api_response["result"] is None) or ("url" not in api_response["result"]):
+            self._LOGGER.debug(f"API returned {api_response['code']}" + "(" + api_response["message"] + ")")
+            return None
+        return api_response["result"]["url"]
+
+    def get_wifi_info_sn(self):
+        device = MiotDevice(self._host, self._token)
+
+        wifi_info_sn = None
+
+        # aggressivly searching for Serial Number in first siid
+        # 1,3 on 2019 - 2021 vacuums; 1,5 on 2022 and newer vacuums
+        piids = [3, 5]
+
+        for piid in piids:
+            data = device.get_property_by(1, piid)
+            if "value" in data[0] and (len(data[0]["value"]) == self.WIFI_STR_LEN and data[0]["value"].isalnum() and data[0]["value"].isupper()):
+                wifi_info_sn = data[0]["value"]
+                break
+
+        if not wifi_info_sn:
+            # property 7, 45 (sweep -> multi-prop-vacuum) on all miot vacuums
+            got_from_vacuum = device.get_property_by(7, 45)
+
+            for prop in got_from_vacuum[0]["value"].split(','):
+                cleaned_prop = str(prop).replace('"', '')
+
+                if str(self._user_id) in cleaned_prop:
+                    cleaned_prop = cleaned_prop.split(';')[0]
+
+                if len(cleaned_prop) == self.WIFI_STR_LEN and cleaned_prop.isalnum() and cleaned_prop.isupper():
+                    wifi_info_sn = cleaned_prop
+        return wifi_info_sn
+
+    def decode_and_parse(self, raw_map: bytes):
+        GET_PROP_RETRIES = 5
+        if self._wifi_info_sn is None or self._wifi_info_sn == "":
+            _LOGGER.debug(f"host={self._host}, token={self._token}")
+            for _ in range(GET_PROP_RETRIES):
+                try:
+                    self._wifi_info_sn = self.get_wifi_info_sn()
+                    _LOGGER.debug(f"wifi_sn = {self._wifi_info_sn}")
+                    break
+                except:
+                    _LOGGER.warn("Failed to get wifi_sn from vacuum")
+
+        decoded_map = self.map_data_parser.unpack_map(
+            raw_map,
+            wifi_sn=self._wifi_info_sn,
+            owner_id=str(self._user_id),
+            device_id=str(self._device_id),
+            model=self.model,
+            device_mac=self._mac)
+        return self.map_data_parser.parse(decoded_map)