---
id: vacuum-map-parser-roborock
version: "0.1.5"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# vacuum-map-parser-roborock — Functionalities for Roborock vacuum map parsing

License: permissive · Maintenance: active · Downloads: 85.9K/mo

## What it is and what it does

This package provides a specialized parser for the binary map format used by Roborock robotic vacuum cleaners. It takes raw map data from a Roborock device and unpacks it into a structured format that can be analyzed or rendered as an image. The parser is built on top of vacuum-map-parser-base, which provides the configuration framework for colors, sizes, drawable elements, and text overlays.

The package is intended for developers integrating Roborock vacuums into home automation systems or building companion applications. It handles the low-level binary protocol parsing so that map visualization and analysis can be built on top. Configuration is done through color palettes, drawable element lists, and image settings passed to the parser at initialization.

Use it for:

- Display real-time or historical vacuum cleaning maps in a home automation dashboard or mobile app.
- Extract room and obstacle data from Roborock maps for integration with smart home systems.
- Analyze vacuum coverage patterns or generate reports on cleaned areas.
- Build custom map visualization tools with application-specific overlays or annotations.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Parses map data generated by Roborock vacuum cleaners, converting raw binary map files into structured data that can be rendered as images with configurable visual elements.

Yes, if you are building a home automation or companion application for Roborock vacuums. The package is actively maintained, has no known vulnerabilities, low install friction, and permissive licensing. It fills a specific niche—Roborock map parsing—with a clean dependency chain. Not relevant for general-purpose use.

## Install

pip install vacuum-map-parser-roborock
uv add vacuum-map-parser-roborock
poetry add vacuum-map-parser-roborock

## Installing vacuum-map-parser-roborock

Before you install: Low friction install with only two runtime dependencies (Pillow and vacuum-map-parser-base). Actively maintained with recent commits and no known vulnerabilities.

License in practice: Apache-2.0 permissive license allows use in commercial and private projects with minimal restrictions; attribution required but no copyleft obligations.

Quickstart:

from vacuum_map_parser_roborock.map_data_parser import RoborockMapDataParser
from vacuum_map_parser_base.config.color import ColorsPalette
from vacuum_map_parser_base.config.image_config import ImageConfig

palette = ColorsPalette()
image_config = ImageConfig()
parser = RoborockMapDataParser(palette, Sizes(), [], image_config, [])
unpacked_map = parser.unpack_map(raw_map_bytes)
parsed_map = parser.parse(unpacked_map)

Requires Python 3.11 or later; raw map data must be obtained from Roborock vacuum device.

Verify before relying:

- Whether the package supports all Roborock vacuum models or only specific firmware versions.
- Performance characteristics when parsing large or complex map files.
- Whether map rendering output formats (image types, resolutions) are documented.

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 85.9K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

roborock vacuum map parser, parse roborock map data, vacuum cleaner map visualization, roborock map binary format, home automation vacuum maps, robot vacuum map rendering, home-automation, robotics

[View on SkillFed](https://skillfed.io/packages/vacuum-map-parser-roborock) · [View on PyPI](https://pypi.org/project/vacuum-map-parser-roborock/)