Skip to content

Commit 6bf9b6b

Browse files
committed
perf(trait): cache rendered base map on Q10 trace updates
1 parent 109f433 commit 6bf9b6b

4 files changed

Lines changed: 141 additions & 13 deletions

File tree

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

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

21+
from vacuum_map_parser_base.map_data import MapData
22+
2123
from roborock.data import RoborockBase
2224
from roborock.data.b01_q10.b01_q10_code_mappings import B01_Q10_DP, Q10RestrictionType, YXDeviceState
2325
from roborock.data.b01_q10.b01_q10_containers import Q10RoborockPoint
2426
from roborock.devices.traits.common import DpsDataConverter, TraitUpdateListener
2527
from roborock.exceptions import RoborockException
28+
from roborock.map.b01_grid_layers import GridCalibration
2629
from roborock.map.b01_q10_map_parser import (
2730
Q10MapPacket,
2831
Q10MapPacketKind,
@@ -31,7 +34,13 @@
3134
Q10TracePacket,
3235
)
3336
from roborock.map.b01_q10_overlays import Q10RestrictedZone, Q10VirtualWall, parse_virtual_wall_blob, parse_zone_blob
34-
from roborock.map.b01_q10_render import Q10MapOverlays, render_q10_map, resolve_q10_current_room
37+
from roborock.map.b01_q10_render import (
38+
Q10MapOverlays,
39+
build_base_q10_map_data,
40+
render_q10_map,
41+
resolve_q10_current_room,
42+
solve_q10_calibration,
43+
)
3544
from roborock.map.map_parser import MapParserConfig
3645
from roborock.protocols.b01_q10_protocol import encode_restricted_zones, encode_room_name, encode_virtual_walls
3746

@@ -108,6 +117,8 @@ def __init__(
108117
self._map_packet: Q10MapPacket | None = None
109118
self._trace_packet: Q10TracePacket | None = None
110119
self._image_content: bytes | None = None
120+
self._base_map_data: MapData | None = None
121+
self._trace_calibration: GridCalibration | None = None
111122
self._map_dps.add_update_listener(self._map_dps_updated)
112123

113124
async def refresh(self) -> None:
@@ -225,6 +236,8 @@ def update_from_map_packet(self, packet: Q10MapPacket) -> None:
225236
if packet.kind is not Q10MapPacketKind.CURRENT:
226237
raise ValueError(f"Expected a current Q10 map packet, got {packet.kind.value}")
227238
self._map_packet = packet
239+
self._base_map_data = None
240+
self._trace_calibration = None
228241
self._render()
229242
self._notify_update()
230243

@@ -241,6 +254,8 @@ def _map_dps_updated(self) -> None:
241254
self._trace_packet = None
242255
if self._map_packet is None:
243256
return
257+
self._base_map_data = None
258+
self._trace_calibration = None
244259
self._render()
245260
self._notify_update()
246261

@@ -249,12 +264,25 @@ def _render(self) -> None:
249264
if self._map_packet is None:
250265
return
251266
try:
267+
trace = self._trace_packet if not self._map_dps.robot_at_dock else None
268+
if self._trace_calibration is None and trace is not None:
269+
self._trace_calibration = solve_q10_calibration(self._map_packet, trace)
270+
if self._trace_calibration is not None and self._map_packet.erase_zones:
271+
self._base_map_data = None
272+
if self._base_map_data is None:
273+
self._base_map_data = build_base_q10_map_data(
274+
self._map_packet,
275+
config=self._config,
276+
trace_calibration=self._trace_calibration,
277+
)
252278
self._image_content = render_q10_map(
253279
self._map_packet,
254-
self._trace_packet if not self._map_dps.robot_at_dock else None,
280+
trace,
255281
self._map_dps.overlays,
256282
config=self._config,
257283
robot_at_dock=self._map_dps.robot_at_dock,
284+
base_map_data=self._base_map_data,
285+
trace_calibration=self._trace_calibration,
258286
)
259287
except RoborockException as ex:
260288
_LOGGER.debug("Failed to render Q10 map packet: %s", ex)

‎roborock/map/b01_q10_render.py‎

Lines changed: 30 additions & 10 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
@@ -88,13 +89,33 @@ class Q10MapOverlays:
8889
virtual_walls: Sequence[Q10Zone] = ()
8990

9091

92+
def build_base_q10_map_data(
93+
packet: Q10MapPacket,
94+
*,
95+
config: MapParserConfig,
96+
trace_calibration: GridCalibration | None = None,
97+
) -> MapData:
98+
"""Build reusable MapData containing the rendered base grid image."""
99+
vector_calibration = _vector_calibration(packet, trace_calibration)
100+
render_packet = packet
101+
if vector_calibration is not None:
102+
cells = _erased_cells(packet.layers, packet.erase_zones, vector_calibration)
103+
if cells:
104+
# Blank the erase-zone cells before parsing the raster so phantom
105+
# areas disappear (as the app shows).
106+
render_packet = erased_packet(packet, cells)
107+
return _map_data_from_packet(render_packet, config=config)
108+
109+
91110
def render_q10_map(
92111
packet: Q10MapPacket,
93112
trace: Q10TracePacket | Q10HistoricalTracePacket | None,
94113
overlays: Q10MapOverlays,
95114
*,
96115
config: MapParserConfig,
97116
robot_at_dock: bool = False,
117+
base_map_data: MapData | None = None,
118+
trace_calibration: GridCalibration | None = None,
98119
) -> bytes:
99120
"""Compose the latest map, trace and DPS inputs into one PNG image.
100121
@@ -103,21 +124,20 @@ def render_q10_map(
103124
available trace and DPS overlays are projected and drawn in pixel space.
104125
Raises :class:`RoborockException` if map rendering fails.
105126
"""
106-
trace_calibration = solve_q10_calibration(packet, trace)
127+
if trace_calibration is None:
128+
trace_calibration = solve_q10_calibration(packet, trace)
107129
vector_calibration = _vector_calibration(packet, trace_calibration)
108130

109-
render_packet = packet
110-
if vector_calibration is not None:
111-
cells = _erased_cells(packet.layers, packet.erase_zones, vector_calibration)
112-
if cells:
113-
# Blank the erase-zone cells before parsing the raster so phantom
114-
# areas disappear (as the app shows).
115-
render_packet = erased_packet(packet, cells)
131+
if base_map_data is None:
132+
base_map_data = build_base_q10_map_data(packet, config=config, trace_calibration=trace_calibration)
116133

117-
map_data = _map_data_from_packet(render_packet, config=config)
118-
if map_data.image is None:
134+
if base_map_data.image is None:
119135
raise RoborockException("Failed to render Q10 map image")
120136

137+
map_data = copy.copy(base_map_data)
138+
map_data.image = copy.copy(base_map_data.image)
139+
map_data.image.data = base_map_data.image.data.copy()
140+
121141
drawables = [drawable for drawable in config.drawables if drawable in _Q10_DRAWABLE_TYPES]
122142
if drawables:
123143
has_drawables = _place_obstacles(map_data, packet)

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

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

383383

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

386427

‎tests/map/test_benchmarks.py‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@
3737
parse_map_packet,
3838
parse_trace_packet,
3939
)
40-
from roborock.map.b01_q10_render import Q10MapOverlays, render_q10_map
40+
from roborock.map.b01_q10_render import (
41+
Q10MapOverlays,
42+
build_base_q10_map_data,
43+
render_q10_map,
44+
solve_q10_calibration,
45+
)
4146
from roborock.map.map_parser import MapParser, MapParserConfig, ParsedMapData
4247

4348
if TYPE_CHECKING:
@@ -217,6 +222,27 @@ def test_benchmark_q10_map_render_with_trace(benchmark: BenchmarkFixture) -> Non
217222
_validate_image(result, (32, 24))
218223

219224

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

246274
benchmarks: list[tuple[str, Callable[[], Any]]] = [
247275
("V1 S5 Map (Scale 4, Default)", lambda: p_v1_s5.parse(v1_s5_data)),
@@ -272,6 +300,17 @@ def _run_benchmarks(iterations: int, warmup: int, profile: bool) -> None:
272300
config=q10_render_config,
273301
),
274302
),
303+
(
304+
"Q10 Render with Trace (Cached)",
305+
lambda: render_q10_map(
306+
q10_map_packet,
307+
trace=q10_trace_packet,
308+
overlays=q10_overlays,
309+
config=q10_render_config,
310+
base_map_data=q10_base_map,
311+
trace_calibration=q10_trace_cal,
312+
),
313+
),
275314
]
276315

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

0 commit comments

Comments
 (0)