Skip to content

Commit 7223b4f

Browse files
committed
Add Route Server Tools documentation and Nav2 Route Tool tutorial
Signed-off-by: bekirbostanci <bekirbostanci@gmail.com>
1 parent 9a07f32 commit 7223b4f

5 files changed

Lines changed: 40 additions & 3 deletions

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _route_server_tools:
2+
3+
Route Server Tools
4+
##################
5+
6+
Route Server tools are essential components in the Nav2 ecosystem that help users create, edit, and manage route graphs for robot navigation. A route graph is a representation of valid paths that a robot can follow in its environment, consisting of nodes (waypoints) and edges (connections between waypoints). These tools simplify the process of defining preferred paths and restricted areas for robot navigation.
7+
8+
Unlike free-space planning, route-based navigation ensures that robots follow specific, predefined paths, which is particularly useful in:
9+
- Industrial environments where specific routes must be followed
10+
- Warehouse operations requiring structured movement patterns
11+
- Facilities with restricted areas or preferred paths
12+
- Multi-robot coordination scenarios where predefined routes help prevent conflicts
13+
14+
Provided Tools
15+
**************
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
20+
route_server_tools/navigation2_route_tool.rst
21+
route_server_tools/route_graph_generation_lif_editor.rst
22+
route_server_tools/route_graph_generation.rst
23+
24+
Description
25+
***********
26+
27+
There are several tools available for creating and editing route graphs for the Nav2 Route Server:
28+
29+
1. **Nav2 Route Tool**: An Rviz panel that allows users to create, edit, and manage route graphs directly within the ROS 2 environment. It supports loading existing graphs, adding/editing/removing nodes and edges, and saving changes to files.
30+
31+
2. **VDA LIF Editor**: A web-based tool that allows users to create route graphs using floor plan images. It can generate both GeoJSON and LIF formats, making it particularly useful for standardized route creation. No installation is required as it runs in a web browser.
32+
33+
3. **Manual Route Graph Generation**: For those who prefer direct file editing, route graphs can be created manually in GeoJSON format. This method provides the most control over the graph structure but requires understanding of the GeoJSON format.
34+
35+
Choose the tool that best fits your needs based on your workflow and requirements.
36+
File renamed without changes.
File renamed without changes.

tutorials/docs/route_graph_generation_lif_editor.rst renamed to tutorials/docs/route_server_tools/route_graph_generation_lif_editor.rst

File renamed without changes.

tutorials/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,19 @@ Nav2 Tutorials
1515
docs/using_groot.rst
1616
docs/integrating_vio.rst
1717
docs/navigation2_dynamic_point_following.rst
18-
docs/navigation2_route_tool.rst
1918
docs/navigation2_with_keepout_filter.rst
2019
docs/navigation2_with_speed_filter.rst
2120
docs/using_docking.rst
2221
docs/using_shim_controller.rst
2322
docs/adding_smoother.rst
2423
docs/using_collision_monitor.rst
25-
docs/route_graph_generation_lif_editor.rst
26-
docs/route_graph_generation.rst
2724
docs/adding_a_nav2_task_server.rst
2825
docs/filtering_of_noise-induced_obstacles.rst
2926
docs/camera_calibration.rst
3027
docs/get_backtrace.rst
3128
docs/get_profile.rst
3229
docs/docker_dev.rst
30+
docs/route_server_tools.rst
31+
docs/route_server_tools/navigation2_route_tool.rst
32+
docs/route_server_tools/route_graph_generation_lif_editor.rst
33+
docs/route_server_tools/route_graph_generation.rst

0 commit comments

Comments
 (0)