Skip to content

Commit 947c6f8

Browse files
committed
docs: explain batched map patch updates
Signed-off-by: SamuelFoo <fooenzesamuel@gmail.com>
1 parent a05e0d0 commit 947c6f8

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

map_server/rmf_layered_map_server/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Default topics:
1212

1313
Dynamic observations expire according to their TTL, so transient local obstacles do not remain in the global planning map forever. A LiDAR or local costmap observer can keep refreshing an obstacle while it is still seen, then let the server decay it after the TTL.
1414

15+
`MapRegionUpdate` messages contain an ordered list of `MapRegionPatch` entries.
16+
A sensor snapshot that clears freespace and marks obstacles should publish clear
17+
patches before obstacle patches in the same message. If the snapshot replaces
18+
the source's previous observation state, set `reset_source` so the server removes
19+
old observations from that `source_id` and `map_name` before adding the new
20+
patches. Resetting has no TTL; clear and obstacle patches both use TTLs in
21+
seconds.
22+
1523
## Visualization Smoke Test
1624

1725
Build and source the workspace:

0 commit comments

Comments
 (0)