Skip to content

Commit a32024b

Browse files
Fix inconsistency in documentation
Signed-off-by: Sushant Chavan <sushant.chavan@idealworks.com>
1 parent bd1148d commit a32024b

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

configuration/packages/configuring-vector-object-server.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Parameters applicable for polygons only
228228
============== =============================
229229

230230
Description:
231-
Polygon vertices, listed in ``{p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, ...}`` format (e.g. ``{0.5, 0.5, 0.5, -0.5, -0.5, -0.5, -0.5, 0.5}`` for the square). Minimum 3 points for a triangle polygon. Causes an error, if not specialized incorrectly (less than 6 or odd number of items in the vector) or not specialized.
231+
Polygon vertices, listed in ``[p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, ...]`` format (e.g. ``[0.5, 0.5, 0.5, -0.5, -0.5, -0.5, -0.5, 0.5]`` for the square). Minimum 3 points for a triangle polygon. Causes an error, if not specialized incorrectly (less than 6 or odd number of items in the vector) or not specialized.
232232

233233
:``<shape_name>``.closed:
234234

tutorials/docs/navigation2_with_vector_objects.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Since vector objects are being enabled in global costmaps, Keepout Filter called
130130
global_costmap:
131131
ros__parameters:
132132
plugins: ["static_layer", "obstacle_layer", "inflation_layer"]
133-
filters: ["vector_object_layer"]
133+
filters: ["keepout_filter", "speed_filter", "vector_object_layer"]
134134
...
135135
vector_object_layer:
136136
plugin: "nav2_costmap_2d::KeepoutFilter"
@@ -150,12 +150,12 @@ We are using composable nodes technology, so in the console where Vector Object
150150

151151
.. code-block:: text
152152
153-
[leha@leha-PC nav2_ws]$ ros2 launch nav2_map_server vector_object_server.launch.py namespace:=global_costmap
153+
[leha@leha-PC nav2_ws]$ ros2 launch nav2_map_server vector_object_server.launch.py
154154
[INFO] [launch]: All log files can be found below /home/leha/.ros/log/2023-11-24-13-18-42-257011-leha-PC-18207
155155
[INFO] [launch]: Default logging verbosity is set to INFO
156-
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/global_costmap/lifecycle_manager_vo_server' in container 'nav2_container'
157-
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/global_costmap/vector_object_server' in container 'nav2_container'
158-
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/global_costmap/costmap_filter_info_server' in container 'nav2_container'
156+
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/lifecycle_manager_vo_server' in container 'nav2_container'
157+
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/vector_object_server' in container 'nav2_container'
158+
[INFO] [launch_ros.actions.load_composable_nodes]: Loaded node '/costmap_filter_info_server' in container 'nav2_container'
159159
160160
The last lines mean that all three nodes: Vector Object server, Costmap Filter Info server, and the Lifecycle Manager handling them, were successfully loaded into the Nav2 container ``nav2_container``.
161161

@@ -180,7 +180,7 @@ To obtain shapes UUID, run the ``GetShapes.srv`` service request from the consol
180180

181181
.. code-block:: bash
182182
183-
ros2 service call /global_costmap/vector_object_server/get_shapes nav2_msgs/srv/GetShapes
183+
ros2 service call /vector_object_server/get_shapes nav2_msgs/srv/GetShapes
184184
185185
The output is expected to be the as follows:
186186

@@ -200,7 +200,7 @@ Call the following service request with obtained UUID to do this:
200200

201201
.. code-block:: bash
202202
203-
ros2 service call /global_costmap/vector_object_server/add_shapes nav2_msgs/srv/AddShapes "polygons: [{points: [{x: 0.0, y: 1.0}, {x: -0.5, y: 1.0}, {x: -0.5, y: 0.0}, {x: 0.0, y: 0.0}], closed: true, value: 100, uuid: {uuid: [153, 128, 30, 121, 241, 60, 76, 15, 140, 187, 58, 60, 164, 241, 97, 39]}}]"
203+
ros2 service call /vector_object_server/add_shapes nav2_msgs/srv/AddShapes "polygons: [{points: [{x: 0.0, y: 1.0}, {x: -0.5, y: 1.0}, {x: -0.5, y: 0.0}, {x: 0.0, y: 0.0}], closed: true, value: 100, uuid: {uuid: [153, 128, 30, 121, 241, 60, 76, 15, 140, 187, 58, 60, 164, 241, 97, 39]}}]"
204204
205205
The polygon shape in Vector Object server will be changed, ``vo_map`` will be updated and resulting costmap will look as follows - triangle obstacle was updated to bar:
206206

@@ -211,7 +211,7 @@ To remove any existing shape, there is ``RemoveShapes.srv`` service supported. I
211211

212212
.. code-block:: bash
213213
214-
ros2 service call /global_costmap/vector_object_server/remove_shapes nav2_msgs/srv/RemoveShapes "all_objects: true"
214+
ros2 service call /vector_object_server/remove_shapes nav2_msgs/srv/RemoveShapes "all_objects: true"
215215
216216
As a result, all vector shapes were disappeared from global costmap:
217217

0 commit comments

Comments
 (0)