Skip to content

Commit 36df1ad

Browse files
committed
perf(trait): cache rendered base map on Q10 trace updates
1 parent ae2da0a commit 36df1ad

5 files changed

Lines changed: 141 additions & 15 deletions

File tree

‎roborock/devices/traits/b01/q10/map.py‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,14 @@
1717
from dataclasses import dataclass, field
1818
from typing import Any
1919

20+
from vacuum_map_parser_base.map_data import MapData
21+
2022
from roborock.data import RoborockBase
2123
from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP, YXDeviceState
2224
from roborock.data.b01_q10.b01_q10_containers import Q10RoborockPoint
2325
from roborock.devices.traits.common import DpsDataConverter, TraitUpdateListener
2426
from roborock.exceptions import RoborockException
27+
from roborock.map.b01_grid_layers import GridCalibration
2528
from roborock.map.b01_q10_map_parser import (
2629
B01Q10MapParserConfig,
2730
Q10MapPacket,
@@ -30,7 +33,12 @@
3033
Q10TracePacket,
3134
)
3235
from roborock.map.b01_q10_overlays import parse_virtual_wall_blob, parse_zone_blob
33-
from roborock.map.b01_q10_render import Q10MapOverlays, render_q10_map
36+
from roborock.map.b01_q10_render import (
37+
Q10MapOverlays,
38+
build_base_q10_map_data,
39+
render_q10_map,
40+
solve_q10_calibration,
41+
)
3442

3543
from .command import CommandTrait
3644
from .common import UpdatableTrait
@@ -105,6 +113,8 @@ def __init__(
105113
self._map_packet: Q10MapPacket | None = None
106114
self._trace_packet: Q10TracePacket | None = None
107115
self._image_content: bytes | None = None
116+
self._base_map_data: MapData | None = None
117+
self._trace_calibration: GridCalibration | None = None
108118
self._map_dps.add_update_listener(self._map_dps_updated)
109119

110120
async def refresh(self) -> None:
@@ -151,6 +161,8 @@ def robot_heading(self) -> int | None:
151161
def update_from_map_packet(self, packet: Q10MapPacket) -> None:
152162
"""Store a map-protocol update and render the latest sources."""
153163
self._map_packet = packet
164+
self._base_map_data = None
165+
self._trace_calibration = None
154166
self._render()
155167
self._notify_update()
156168

@@ -164,6 +176,8 @@ def _map_dps_updated(self) -> None:
164176
"""Render after the low-level map DPS source changes."""
165177
if self._map_packet is None:
166178
return
179+
self._base_map_data = None
180+
self._trace_calibration = None
167181
self._render()
168182
self._notify_update()
169183

@@ -172,12 +186,25 @@ def _render(self) -> None:
172186
if self._map_packet is None:
173187
return
174188
try:
189+
trace = self._trace_packet if not self._map_dps.robot_at_dock else None
190+
if self._trace_calibration is None and trace is not None:
191+
self._trace_calibration = solve_q10_calibration(self._map_packet, trace)
192+
if self._trace_calibration is not None and self._map_packet.erase_zones:
193+
self._base_map_data = None
194+
if self._base_map_data is None:
195+
self._base_map_data = build_base_q10_map_data(
196+
self._map_packet,
197+
config=self._config,
198+
trace_calibration=self._trace_calibration,
199+
)
175200
self._image_content = render_q10_map(
176201
self._map_packet,
177-
self._trace_packet if not self._map_dps.robot_at_dock else None,
202+
trace,
178203
self._map_dps.overlays,
179204
config=self._config,
180205
robot_at_dock=self._map_dps.robot_at_dock,
206+
base_map_data=self._base_map_data,
207+
trace_calibration=self._trace_calibration,
181208
)
182209
except RoborockException as ex:
183210
_LOGGER.debug("Failed to render Q10 map packet: %s", ex)

‎roborock/map/b01_q10_map_parser.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import statistics
2626
import struct
2727
from dataclasses import dataclass, field, replace
28+
from functools import cached_property
2829

2930
from PIL import Image
3031
from vacuum_map_parser_base.config.color import ColorsPalette, SupportedColor
@@ -238,7 +239,7 @@ class Q10MapPacket:
238239
the same (top-down) pixel space as :attr:`grid`, where a non-zero cell is
239240
carpet (the value is the carpet kind). ``None`` if the packet carried none."""
240241

241-
@property
242+
@cached_property
242243
def layers(self) -> GridLayers:
243244
"""Split the occupancy grid into separable grid-pixel layers."""
244245
rooms = [(room.id, room.name, room.pixel_value, room.pixel_count) for room in self.rooms]

‎roborock/map/b01_q10_render.py‎

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
drawing) and the calibration policy live here, next to the rest of the map code.
1414
"""
1515

16+
import copy
1617
import io
1718
import math
1819
from collections.abc import Sequence
@@ -82,13 +83,32 @@ class Q10MapOverlays:
8283
virtual_walls: Sequence[Q10Zone] = ()
8384

8485

86+
def build_base_q10_map_data(
87+
packet: Q10MapPacket,
88+
*,
89+
config: B01Q10MapParserConfig,
90+
trace_calibration: GridCalibration | None = None,
91+
) -> MapData:
92+
"""Build reusable MapData containing the rendered base grid image."""
93+
parser = B01Q10MapParser(config)
94+
vector_calibration = _vector_calibration(packet, trace_calibration)
95+
render_packet = packet
96+
if vector_calibration is not None:
97+
cells = _erased_cells(packet.layers, packet.erase_zones, vector_calibration)
98+
if cells:
99+
render_packet = erased_packet(packet, cells)
100+
return parser.map_data_from_packet(render_packet)
101+
102+
85103
def render_q10_map(
86104
packet: Q10MapPacket,
87105
trace: Q10TracePacket | Q10HistoricalTracePacket | None,
88106
overlays: Q10MapOverlays,
89107
*,
90108
config: B01Q10MapParserConfig,
91109
robot_at_dock: bool = False,
110+
base_map_data: MapData | None = None,
111+
trace_calibration: GridCalibration | None = None,
92112
) -> bytes:
93113
"""Compose the latest map, trace and DPS inputs into one PNG image.
94114
@@ -97,22 +117,20 @@ def render_q10_map(
97117
available trace and DPS overlays are projected and drawn in pixel space.
98118
Raises :class:`RoborockException` if map rendering fails.
99119
"""
100-
parser = B01Q10MapParser(config)
101-
trace_calibration = solve_q10_calibration(packet, trace)
120+
if trace_calibration is None:
121+
trace_calibration = solve_q10_calibration(packet, trace)
102122
vector_calibration = _vector_calibration(packet, trace_calibration)
103123

104-
render_packet = packet
105-
if vector_calibration is not None:
106-
cells = _erased_cells(packet.layers, packet.erase_zones, vector_calibration)
107-
if cells:
108-
# Blank the erase-zone cells before parsing the raster so phantom
109-
# areas disappear (as the app shows).
110-
render_packet = erased_packet(packet, cells)
124+
if base_map_data is None:
125+
base_map_data = build_base_q10_map_data(packet, config=config, trace_calibration=trace_calibration)
111126

112-
map_data = parser.map_data_from_packet(render_packet)
113-
if map_data.image is None:
127+
if base_map_data.image is None:
114128
raise RoborockException("Failed to render Q10 map image")
115129

130+
map_data = copy.copy(base_map_data)
131+
map_data.image = copy.copy(base_map_data.image)
132+
map_data.image.data = base_map_data.image.data.copy()
133+
116134
has_drawables = False
117135
if trace_calibration is not None and trace is not None:
118136
charger_heading = packet.header_calibration.charger_phi if packet.header_calibration is not None else None

‎tests/devices/traits/b01/q10/test_map.py‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,47 @@ def test_render_failure_clears_stale_image(render_map: Mock) -> None:
388388
assert trait.image_content is None
389389

390390

391+
def test_trace_updates_reuse_cached_base_map_and_calibration() -> None:
392+
"""Subsequent trace updates reuse the rendered base map without rebuilding it."""
393+
map_dps = MapDpsTrait()
394+
trait = _map_trait(map_dps)
395+
packet = parse_map_packet(FIXTURE.read_bytes())
396+
trace1 = parse_trace_packet(TRACE_SESSION_FIXTURE.read_bytes())
397+
trace2 = Q10TracePacket(points=[*trace1.points, Q10Point(100, 100)], sequence=trace1.sequence + 1)
398+
399+
with (
400+
patch(
401+
"roborock.devices.traits.b01.q10.map.build_base_q10_map_data",
402+
wraps=None,
403+
) as mock_build_base,
404+
patch(
405+
"roborock.devices.traits.b01.q10.map.solve_q10_calibration",
406+
wraps=None,
407+
) as mock_solve_cal,
408+
patch("roborock.devices.traits.b01.q10.map.render_q10_map", return_value=b"png") as mock_render,
409+
):
410+
mock_build_base.return_value = Mock()
411+
mock_solve_cal.return_value = Mock()
412+
413+
trait.update_from_map_packet(packet)
414+
assert mock_build_base.call_count == 1
415+
assert mock_solve_cal.call_count == 0
416+
417+
trait.update_from_trace_packet(trace1)
418+
assert mock_build_base.call_count == 1
419+
assert mock_solve_cal.call_count == 1
420+
421+
trait.update_from_trace_packet(trace2)
422+
assert mock_build_base.call_count == 1
423+
assert mock_solve_cal.call_count == 1
424+
assert mock_render.call_count == 3
425+
426+
# A DPS update or new map packet invalidates the cached base map.
427+
map_dps.update_from_dps({B01_Q10_DP.RESTRICTED_ZONE_UP: _zone_blob()})
428+
assert mock_build_base.call_count == 2
429+
assert mock_solve_cal.call_count == 2
430+
431+
391432
# --- Overlays ----------------------------------------------------------------
392433

393434

‎tests/map/test_benchmarks.py‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,12 @@
3939
parse_map_packet,
4040
parse_trace_packet,
4141
)
42-
from roborock.map.b01_q10_render import Q10MapOverlays, render_q10_map
42+
from roborock.map.b01_q10_render import (
43+
Q10MapOverlays,
44+
build_base_q10_map_data,
45+
render_q10_map,
46+
solve_q10_calibration,
47+
)
4348
from roborock.map.map_parser import MapParser, MapParserConfig, ParsedMapData
4449

4550
if TYPE_CHECKING:
@@ -218,6 +223,27 @@ def test_benchmark_q10_map_render_with_trace(benchmark: BenchmarkFixture) -> Non
218223
_validate_image(result, (32, 24))
219224

220225

226+
def test_benchmark_q10_map_render_with_trace_cached(benchmark: BenchmarkFixture) -> None:
227+
"""Benchmark Q10 render_q10_map on trace updates using cached base MapData and calibration."""
228+
map_bytes = _Q10_MAP.read_bytes()
229+
trace_bytes = _Q10_TRACE.read_bytes()
230+
packet = parse_map_packet(map_bytes)
231+
trace = parse_trace_packet(trace_bytes)
232+
config = B01Q10MapParserConfig(map_scale=4)
233+
trace_calibration = solve_q10_calibration(packet, trace)
234+
base_map_data = build_base_q10_map_data(packet, config=config, trace_calibration=trace_calibration)
235+
result = benchmark(
236+
render_q10_map,
237+
packet,
238+
trace=trace,
239+
overlays=Q10MapOverlays(),
240+
config=config,
241+
base_map_data=base_map_data,
242+
trace_calibration=trace_calibration,
243+
)
244+
_validate_image(result, (32, 24))
245+
246+
221247
# ---------------------------------------------------------------------------
222248
# Standalone CLI Benchmark & Profiler
223249
# ---------------------------------------------------------------------------
@@ -244,6 +270,8 @@ def _run_benchmarks(iterations: int, warmup: int, profile: bool) -> None:
244270
q10_map_packet = parse_map_packet(q10_data)
245271
q10_trace_packet = parse_trace_packet(q10_trace_data)
246272
q10_render_config = B01Q10MapParserConfig(map_scale=4)
273+
q10_trace_cal = solve_q10_calibration(q10_map_packet, q10_trace_packet)
274+
q10_base_map = build_base_q10_map_data(q10_map_packet, config=q10_render_config, trace_calibration=q10_trace_cal)
247275

248276
benchmarks: list[tuple[str, Callable[[], Any]]] = [
249277
("V1 S5 Map (Scale 4, Default)", lambda: p_v1_s5.parse(v1_s5_data)),
@@ -265,6 +293,17 @@ def _run_benchmarks(iterations: int, warmup: int, profile: bool) -> None:
265293
config=q10_render_config,
266294
),
267295
),
296+
(
297+
"Q10 Render with Trace (Cached)",
298+
lambda: render_q10_map(
299+
q10_map_packet,
300+
trace=q10_trace_packet,
301+
overlays=Q10MapOverlays(),
302+
config=q10_render_config,
303+
base_map_data=q10_base_map,
304+
trace_calibration=q10_trace_cal,
305+
),
306+
),
268307
]
269308

270309
print(f"\nRunning {len(benchmarks)} benchmarks ({warmup} warmup, {iterations} timed iterations)...\n")

0 commit comments

Comments
 (0)