Skip to content

Commit c552216

Browse files
add map server docs (ros-navigation#24)
* add map server docs * Update configuration/packages/configuring-map-server.rst Co-authored-by: Marwan Taher <[email protected]> * Update configuration/packages/configuring-map-server.rst Co-authored-by: Marwan Taher <[email protected]> Co-authored-by: Marwan Taher <[email protected]>
1 parent a7510ee commit c552216

File tree

2 files changed

+100
-0
lines changed

2 files changed

+100
-0
lines changed

configuration/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ the best navigation performance.
1616
packages/configuring-navfn.rst
1717
packages/configuring-controller-server.rst
1818
packages/configuring-dwb.rst
19+
packages/configuring-map-server.rst
1920
params/tunable-params.rst
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
.. _configuring_map_server:
2+
3+
Map Server / Saver
4+
##################
5+
6+
Source code on Github_.
7+
8+
.. _Github: https://github.com/ros-planning/navigation2/tree/master/nav2_map_server
9+
10+
The Map Server implements the server for handling the map load requests for the stack and host a map topic.
11+
It also implements a map saver server which will run in the background and save maps based on service requests. There exists a map saver CLI similar to ROS1 as well for a single map save.
12+
13+
Map Saver Parameters
14+
********************
15+
16+
:save_map_timeout:
17+
18+
============== =======
19+
Type Default
20+
-------------- -------
21+
int 2000
22+
============== =======
23+
24+
Description
25+
Timeout to attempt saving the map (ms).
26+
27+
:free_thresh_default:
28+
29+
============== ==============
30+
Type Default
31+
-------------- --------------
32+
double 0.25
33+
============== ==============
34+
35+
Description
36+
Free space maximum probability threshold value for occupancy grid.
37+
38+
:occupied_thresh_default:
39+
40+
============== =============================
41+
Type Default
42+
-------------- -----------------------------
43+
double 0.65
44+
============== =============================
45+
46+
Description
47+
Occupied space minimum threshhold for occupancy grid.
48+
49+
Map Server Parameters
50+
*********************
51+
52+
:yaml_filename:
53+
54+
============== =============================
55+
Type Default
56+
-------------- -----------------------------
57+
string N/A
58+
============== =============================
59+
60+
Description
61+
Path to map yaml file.
62+
63+
:topic_name:
64+
65+
============== =============================
66+
Type Default
67+
-------------- -----------------------------
68+
string "map"
69+
============== =============================
70+
71+
Description
72+
Topic to publish loaded map to.
73+
74+
:frame_id:
75+
76+
============== =============================
77+
Type Default
78+
-------------- -----------------------------
79+
string "map"
80+
============== =============================
81+
82+
Description
83+
Frame to publish loaded map in.
84+
85+
Example
86+
*******
87+
.. code-block:: yaml
88+
89+
map_server:
90+
ros__parameters:
91+
yaml_filename: "turtlebot3_world.yaml"
92+
topic_name: "map"
93+
frame_id: "map"
94+
95+
map_saver:
96+
ros__parameters:
97+
save_map_timeout: 5000
98+
free_thresh_default: 0.25
99+
occupied_thresh_default: 0.65

0 commit comments

Comments
 (0)