valetudo-map-parser 0.1.9b41__tar.gz → 0.1.9b42__tar.gz

valetudo_map_parser-0.1.9b42/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.3
+Name: valetudo-map-parser
+Version: 0.1.9b42
+Summary: A Python library to parse Valetudo map data returning a PIL Image object.
+License: Apache-2.0
+Author: Sandro Cantarella
+Author-email: gsca075@gmail.com
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: Pillow (>=10.3.0)
+Requires-Dist: numpy (>=1.26.4)
+Project-URL: Bug Tracker, https://github.com/sca075/Python-package-valetudo-map-parser/issues
+Project-URL: Changelog, https://github.com/sca075/Python-package-valetudo-map-parser/releases
+Project-URL: Homepage, https://github.com/sca075/Python-package-valetudo-map-parser
+Project-URL: Repository, https://github.com/sca075/Python-package-valetudo-map-parser
+Description-Content-Type: text/markdown
+
+# Python-package-valetudo-map-parser
+
+---
+### What is it:
+❗This is an _unofficial_ project and is not created, maintained, or in any sense linked to [valetudo.cloud](https://valetudo.cloud)
+
+A Python library that converts Valetudo vacuum JSON map data into PIL (Python Imaging Library) images. This package is primarily developed for and used in the [MQTT Vacuum Camera](https://github.com/sca075/mqtt_vacuum_camera) project.
+
+---
+
+### Features:
+- Processes map data from Valetudo-compatible robot vacuums
+- Supports both Hypfer and Rand256 vacuum data formats
+- Renders comprehensive map visualizations including:
+  - Walls and obstacles
+  - Robot position and cleaning path
+  - Room segments and boundaries
+  - Cleaning zones
+  - Virtual restrictions
+  - LiDAR data
+- Provides auto-cropping and dynamic zooming
+- Supports image rotation and aspect ratio management
+- Enables custom color schemes
+- Handles multilingual labels
+- Implements thread-safe data sharing
+
+### Installation:
+```bash
+pip install valetudo_map_parser
+```
+
+### Requirements:
+- Python 3.12 or higher
+- Dependencies:
+  - Pillow (PIL) for image processing
+  - NumPy for array operations
+
+### Usage:
+The library is configured using a dictionary format. See our [sample code](https://github.com/sca075/Python-package-valetudo-map-parser/blob/main/tests/test.py) for implementation examples.
+
+Key functionalities:
+- Decodes raw data from Rand256 format
+- Processes JSON data from compatible vacuums
+- Returns Pillow PNG images
+- Provides calibration and room property extraction
+- Supports asynchronous operations
+
+### Development Status:
+Current version: 0.1.9.b41
+- Full functionality available in versions >= 0.1.9
+- Actively maintained and enhanced
+- Uses Poetry for dependency management
+- Implements comprehensive testing
+- Enforces code quality through ruff, isort, and pylint
+
+### Contributing:
+Contributions are welcome! You can help by:
+- Submitting code improvements
+- Enhancing documentation
+- Reporting issues
+- Suggesting new features
+
+### Disclaimer:
+This project is provided "as is" without warranty of any kind. Users assume all risks associated with its use.
+
+### License:
+Apache-2.0
+
+---
+For more information about Valetudo, visit [valetudo.cloud](https://valetudo.cloud)
+Integration with Home Assistant: [MQTT Vacuum Camera](https://github.com/sca075/mqtt_vacuum_camera)
+

valetudo_map_parser-0.1.9b42/README.md

@@ -0,0 +1,71 @@
+# Python-package-valetudo-map-parser
+
+---
+### What is it:
+❗This is an _unofficial_ project and is not created, maintained, or in any sense linked to [valetudo.cloud](https://valetudo.cloud)
+
+A Python library that converts Valetudo vacuum JSON map data into PIL (Python Imaging Library) images. This package is primarily developed for and used in the [MQTT Vacuum Camera](https://github.com/sca075/mqtt_vacuum_camera) project.
+
+---
+
+### Features:
+- Processes map data from Valetudo-compatible robot vacuums
+- Supports both Hypfer and Rand256 vacuum data formats
+- Renders comprehensive map visualizations including:
+  - Walls and obstacles
+  - Robot position and cleaning path
+  - Room segments and boundaries
+  - Cleaning zones
+  - Virtual restrictions
+  - LiDAR data
+- Provides auto-cropping and dynamic zooming
+- Supports image rotation and aspect ratio management
+- Enables custom color schemes
+- Handles multilingual labels
+- Implements thread-safe data sharing
+
+### Installation:
+```bash
+pip install valetudo_map_parser
+```
+
+### Requirements:
+- Python 3.12 or higher
+- Dependencies:
+  - Pillow (PIL) for image processing
+  - NumPy for array operations
+
+### Usage:
+The library is configured using a dictionary format. See our [sample code](https://github.com/sca075/Python-package-valetudo-map-parser/blob/main/tests/test.py) for implementation examples.
+
+Key functionalities:
+- Decodes raw data from Rand256 format
+- Processes JSON data from compatible vacuums
+- Returns Pillow PNG images
+- Provides calibration and room property extraction
+- Supports asynchronous operations
+
+### Development Status:
+Current version: 0.1.9.b41
+- Full functionality available in versions >= 0.1.9
+- Actively maintained and enhanced
+- Uses Poetry for dependency management
+- Implements comprehensive testing
+- Enforces code quality through ruff, isort, and pylint
+
+### Contributing:
+Contributions are welcome! You can help by:
+- Submitting code improvements
+- Enhancing documentation
+- Reporting issues
+- Suggesting new features
+
+### Disclaimer:
+This project is provided "as is" without warranty of any kind. Users assume all risks associated with its use.
+
+### License:
+Apache-2.0
+
+---
+For more information about Valetudo, visit [valetudo.cloud](https://valetudo.cloud)
+Integration with Home Assistant: [MQTT Vacuum Camera](https://github.com/sca075/mqtt_vacuum_camera)

{valetudo_map_parser-0.1.9b41 → valetudo_map_parser-0.1.9b42}/SCR/valetudo_map_parser/__init__.py

@@ -1,8 +1,10 @@
 """Valetudo map parser.
-Version: 0.1.8"""
+Version: 0.1.9"""
 
 from .config.colors import ColorsManagment
 from .config.drawable import Drawable
+from .config.drawable_elements import DrawableElement, DrawingConfig
+from .config.enhanced_drawable import EnhancedDrawable
 from .config.rand25_parser import RRMapParser
 from .config.shared import CameraShared, CameraSharedManager
 from .config.types import (
@@ -25,10 +27,11 @@ __all__ = [
     "CameraSharedManager",
     "ColorsManagment",
     "Drawable",
+    "DrawableElement",
+    "DrawingConfig",
+    "EnhancedDrawable",
     "SnapshotStore",
     "UserLanguageStore",
-    "UserLanguageStore",
-    "SnapshotStore",
     "RoomStore",
     "RoomsProperties",
     "TrimCropData",

{valetudo_map_parser-0.1.9b41 → valetudo_map_parser-0.1.9b42}/SCR/valetudo_map_parser/config/drawable.py

@@ -10,14 +10,20 @@ Refactored for clarity, consistency, and optimized parameter usage.
 from __future__ import annotations
 
 import asyncio
+import logging
 import math
 
+# cv2 is imported but not used directly in this file
+# It's needed for other modules that import from here
 import numpy as np
 from PIL import ImageDraw, ImageFont
 
 from .types import Color, NumpyArray, PilPNG, Point, Tuple, Union
 
 
+_LOGGER = logging.getLogger(__name__)
+
+
 class Drawable:
     """
     Collection of drawing utility functions for the image handlers.
@@ -47,16 +53,30 @@ class Drawable:
     ) -> NumpyArray:
         """Draw the layers (rooms) from the vacuum JSON data onto the image array."""
         image_array = layer
+        # Extract alpha from color
+        alpha = color[3] if len(color) == 4 else 255
+
+        # For debugging
+        _LOGGER.debug("Drawing with color %s and alpha %s", color, alpha)
+
+        # Create the full color with alpha
+        full_color = color if len(color) == 4 else (*color, 255)
+
         # Loop through pixels to find min and max coordinates
         for x, y, z in pixels:
             col = x * pixel_size
             row = y * pixel_size
             # Draw pixels as blocks
             for i in range(z):
-                image_array[
+                # Get the region to update
+                region = image_array[
                     row : row + pixel_size,
                     col + i * pixel_size : col + (i + 1) * pixel_size,
-                ] = color
+                ]
+
+                # Simple direct assignment - ignore alpha for now to ensure visibility
+                region[:] = full_color
+
         return image_array
 
     @staticmethod

valetudo_map_parser-0.1.9b42/SCR/valetudo_map_parser/config/drawable_elements.py

@@ -0,0 +1,312 @@
+"""
+Drawable Elements Configuration.
+Defines the elements that can be drawn on the map and their properties.
+Version: 0.1.9
+"""
+
+from __future__ import annotations
+
+import logging
+from enum import IntEnum
+from typing import Dict, List, Tuple, Union
+
+from .colors import DefaultColors, SupportedColor
+
+
+# numpy is not used in this file
+
+
+_LOGGER = logging.getLogger(__name__)
+
+# Type aliases
+Color = Tuple[int, int, int, int]  # RGBA color
+PropertyDict = Dict[str, Union[Color, float, int]]
+
+
+class DrawableElement(IntEnum):
+    """Enumeration of drawable map elements with unique integer codes."""
+
+    # Base elements
+    FLOOR = 1
+    WALL = 2
+    ROBOT = 3
+    CHARGER = 4
+    VIRTUAL_WALL = 5
+    RESTRICTED_AREA = 6
+    NO_MOP_AREA = 7
+    OBSTACLE = 8
+    PATH = 9
+    PREDICTED_PATH = 10
+    GO_TO_TARGET = 11
+
+    # Rooms (101-115 for up to 15 rooms)
+    ROOM_1 = 101
+    ROOM_2 = 102
+    ROOM_3 = 103
+    ROOM_4 = 104
+    ROOM_5 = 105
+    ROOM_6 = 106
+    ROOM_7 = 107
+    ROOM_8 = 108
+    ROOM_9 = 109
+    ROOM_10 = 110
+    ROOM_11 = 111
+    ROOM_12 = 112
+    ROOM_13 = 113
+    ROOM_14 = 114
+    ROOM_15 = 115
+
+
+class DrawingConfig:
+    """Configuration for which elements to draw and their properties."""
+
+    def __init__(self):
+        """Initialize with all elements enabled by default."""
+        # Dictionary of element_code -> enabled status
+        self._enabled_elements = {element: True for element in DrawableElement}
+
+        # Dictionary of element_code -> drawing properties (color, opacity, etc.)
+        self._element_properties: Dict[DrawableElement, PropertyDict] = {}
+
+        # Initialize default properties
+        self._set_default_properties()
+
+    def _set_default_properties(self):
+        """Set default drawing properties for each element."""
+        # Set properties for rooms using DefaultColors
+        for room_id in range(1, 16):
+            room_element = getattr(DrawableElement, f"ROOM_{room_id}")
+            room_key = SupportedColor.room_key(room_id - 1)
+            rgb = DefaultColors.DEFAULT_ROOM_COLORS.get(room_key, (135, 206, 250))
+            alpha = DefaultColors.DEFAULT_ALPHA.get(f"alpha_room_{room_id - 1}", 255.0)
+
+            self._element_properties[room_element] = {
+                "color": (*rgb, int(alpha)),
+                "opacity": alpha / 255.0,
+                "z_index": 10,  # Drawing order
+            }
+
+        # Map DrawableElement to SupportedColor
+        element_color_mapping = {
+            DrawableElement.FLOOR: SupportedColor.MAP_BACKGROUND,
+            DrawableElement.WALL: SupportedColor.WALLS,
+            DrawableElement.ROBOT: SupportedColor.ROBOT,
+            DrawableElement.CHARGER: SupportedColor.CHARGER,
+            DrawableElement.VIRTUAL_WALL: SupportedColor.NO_GO,
+            DrawableElement.RESTRICTED_AREA: SupportedColor.NO_GO,
+            DrawableElement.PATH: SupportedColor.PATH,
+            DrawableElement.PREDICTED_PATH: SupportedColor.PREDICTED_PATH,
+            DrawableElement.GO_TO_TARGET: SupportedColor.GO_TO,
+            DrawableElement.NO_MOP_AREA: SupportedColor.NO_GO,  # Using NO_GO for no-mop areas
+            DrawableElement.OBSTACLE: SupportedColor.NO_GO,  # Using NO_GO for obstacles
+        }
+
+        # Set z-index for each element type
+        z_indices = {
+            DrawableElement.FLOOR: 0,
+            DrawableElement.WALL: 20,
+            DrawableElement.ROBOT: 50,
+            DrawableElement.CHARGER: 40,
+            DrawableElement.VIRTUAL_WALL: 30,
+            DrawableElement.RESTRICTED_AREA: 25,
+            DrawableElement.NO_MOP_AREA: 25,
+            DrawableElement.OBSTACLE: 15,
+            DrawableElement.PATH: 35,
+            DrawableElement.PREDICTED_PATH: 34,
+            DrawableElement.GO_TO_TARGET: 45,
+        }
+
+        # Set properties for other elements using DefaultColors
+        for element, color_key in element_color_mapping.items():
+            rgb = DefaultColors.COLORS_RGB.get(color_key, (0, 0, 0))
+            alpha_key = f"alpha_{color_key}"
+            alpha = DefaultColors.DEFAULT_ALPHA.get(alpha_key, 255.0)
+
+            # Special case for semi-transparent elements
+            if element in [
+                DrawableElement.RESTRICTED_AREA,
+                DrawableElement.NO_MOP_AREA,
+                DrawableElement.PREDICTED_PATH,
+            ]:
+                alpha = 125.0  # Semi-transparent by default
+
+            self._element_properties[element] = {
+                "color": (*rgb, int(alpha)),
+                "opacity": alpha / 255.0,
+                "z_index": z_indices.get(element, 0),
+            }
+
+    def enable_element(self, element_code: DrawableElement) -> None:
+        """Enable drawing of a specific element."""
+        if element_code in self._enabled_elements:
+            self._enabled_elements[element_code] = True
+            _LOGGER.info(
+                "Enabled element %s (%s)", element_code.name, element_code.value
+            )
+            _LOGGER.info(
+                "Element %s is now enabled: %s",
+                element_code.name,
+                self._enabled_elements[element_code],
+            )
+
+    def disable_element(self, element_code: DrawableElement) -> None:
+        """Disable drawing of a specific element."""
+        if element_code in self._enabled_elements:
+            self._enabled_elements[element_code] = False
+            _LOGGER.info(
+                "Disabled element %s (%s)", element_code.name, element_code.value
+            )
+            _LOGGER.info(
+                "Element %s is now enabled: %s",
+                element_code.name,
+                self._enabled_elements[element_code],
+            )
+
+    def set_elements(self, element_codes: List[DrawableElement]) -> None:
+        """Enable only the specified elements, disable all others."""
+        # First disable all
+        for element in self._enabled_elements:
+            self._enabled_elements[element] = False
+
+        # Then enable specified ones
+        for element in element_codes:
+            if element in self._enabled_elements:
+                self._enabled_elements[element] = True
+
+    def is_enabled(self, element_code: DrawableElement) -> bool:
+        """Check if an element is enabled for drawing."""
+        enabled = self._enabled_elements.get(element_code, False)
+        _LOGGER.debug(
+            "Checking if element %s is enabled: %s",
+            element_code.name if hasattr(element_code, "name") else element_code,
+            enabled,
+        )
+        return enabled
+
+    def set_property(
+        self, element_code: DrawableElement, property_name: str, value
+    ) -> None:
+        """Set a drawing property for an element."""
+        if element_code in self._element_properties:
+            self._element_properties[element_code][property_name] = value
+
+    def get_property(
+        self, element_code: DrawableElement, property_name: str, default=None
+    ):
+        """Get a drawing property for an element."""
+        if element_code in self._element_properties:
+            return self._element_properties[element_code].get(property_name, default)
+        return default
+
+    def get_enabled_elements(self) -> List[DrawableElement]:
+        """Get list of enabled element codes."""
+        return [
+            element for element, enabled in self._enabled_elements.items() if enabled
+        ]
+
+    def get_drawing_order(self) -> List[DrawableElement]:
+        """Get list of enabled elements in drawing order (by z_index)."""
+        enabled = self.get_enabled_elements()
+        return sorted(enabled, key=lambda e: self.get_property(e, "z_index", 0))
+
+    def update_from_device_info(self, device_info: dict) -> None:
+        """Update configuration based on device info dictionary."""
+        # Map DrawableElement to SupportedColor
+        element_color_mapping = {
+            DrawableElement.FLOOR: SupportedColor.MAP_BACKGROUND,
+            DrawableElement.WALL: SupportedColor.WALLS,
+            DrawableElement.ROBOT: SupportedColor.ROBOT,
+            DrawableElement.CHARGER: SupportedColor.CHARGER,
+            DrawableElement.VIRTUAL_WALL: SupportedColor.NO_GO,
+            DrawableElement.RESTRICTED_AREA: SupportedColor.NO_GO,
+            DrawableElement.PATH: SupportedColor.PATH,
+            DrawableElement.PREDICTED_PATH: SupportedColor.PREDICTED_PATH,
+            DrawableElement.GO_TO_TARGET: SupportedColor.GO_TO,
+            DrawableElement.NO_MOP_AREA: SupportedColor.NO_GO,
+            DrawableElement.OBSTACLE: SupportedColor.NO_GO,
+        }
+
+        # Update room colors from device info
+        for room_id in range(1, 16):
+            room_element = getattr(DrawableElement, f"ROOM_{room_id}")
+            color_key = SupportedColor.room_key(room_id - 1)
+            alpha_key = f"alpha_room_{room_id - 1}"
+
+            if color_key in device_info:
+                rgb = device_info[color_key]
+                alpha = device_info.get(alpha_key, 255.0)
+
+                # Create RGBA color
+                rgba = (*rgb, int(alpha))
+
+                # Update color and opacity
+                self.set_property(room_element, "color", rgba)
+                self.set_property(room_element, "opacity", alpha / 255.0)
+
+                _LOGGER.debug(
+                    "Updated room %d color to %s with alpha %s", room_id, rgb, alpha
+                )
+
+        # Update other element colors
+        for element, color_key in element_color_mapping.items():
+            if color_key in device_info:
+                rgb = device_info[color_key]
+                alpha_key = f"alpha_{color_key}"
+                alpha = device_info.get(alpha_key, 255.0)
+
+                # Special case for semi-transparent elements
+                if element in [
+                    DrawableElement.RESTRICTED_AREA,
+                    DrawableElement.NO_MOP_AREA,
+                    DrawableElement.PREDICTED_PATH,
+                ]:
+                    if alpha > 200:  # If alpha is too high for these elements
+                        alpha = 125.0  # Use a more appropriate default
+
+                # Create RGBA color
+                rgba = (*rgb, int(alpha))
+
+                # Update color and opacity
+                self.set_property(element, "color", rgba)
+                self.set_property(element, "opacity", alpha / 255.0)
+
+                _LOGGER.debug(
+                    "Updated element %s color to %s with alpha %s",
+                    element.name,
+                    rgb,
+                    alpha,
+                )
+
+        # Check for disabled elements using specific boolean flags
+        # Map element disable flags to DrawableElement enum values
+        element_disable_mapping = {
+            "disable_floor": DrawableElement.FLOOR,
+            "disable_wall": DrawableElement.WALL,
+            "disable_robot": DrawableElement.ROBOT,
+            "disable_charger": DrawableElement.CHARGER,
+            "disable_virtual_walls": DrawableElement.VIRTUAL_WALL,
+            "disable_restricted_areas": DrawableElement.RESTRICTED_AREA,
+            "disable_no_mop_areas": DrawableElement.NO_MOP_AREA,
+            "disable_obstacles": DrawableElement.OBSTACLE,
+            "disable_path": DrawableElement.PATH,
+            "disable_predicted_path": DrawableElement.PREDICTED_PATH,
+            "disable_go_to_target": DrawableElement.GO_TO_TARGET,
+        }
+
+        # Process base element disable flags
+        for disable_key, element in element_disable_mapping.items():
+            if device_info.get(disable_key, False):
+                self.disable_element(element)
+                _LOGGER.info(
+                    "Disabled %s element from device_info setting", element.name
+                )
+
+        # Process room disable flags (1-15)
+        for room_id in range(1, 16):
+            disable_key = f"disable_room_{room_id}"
+            if device_info.get(disable_key, False):
+                room_element = getattr(DrawableElement, f"ROOM_{room_id}")
+                self.disable_element(room_element)
+                _LOGGER.info(
+                    "Disabled ROOM_%d element from device_info setting", room_id
+                )