Skip to content

Commit 939836f

Browse files
committed
feat: add tabs to migration guide
Signed-off-by: AJedancov <andrei.jedancov@gmail.com>
1 parent b3037c0 commit 939836f

1 file changed

Lines changed: 79 additions & 26 deletions

File tree

migration/Kilted.rst

Lines changed: 79 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,43 @@ along with the corresponding parameters associated with updated names, including
5050

5151
Examples from updated YAML configuration files:
5252

53-
.. code-block:: yaml
53+
.. tabs::
5454

55-
controller_server:
56-
ros__parameters:
57-
controller_plugins: ["follow_path"]
58-
follow_path:
59-
plugin: "nav2_mppi_controller::MPPIController"
55+
.. group-tab:: Lyrical
6056

61-
.. code-block:: yaml
57+
.. code-block:: yaml
6258
63-
collision_monitor:
64-
ros__parameters:
65-
polygons: ["footprint_approach"]
66-
footprint_approach:
67-
type: "polygon"
59+
controller_server:
60+
ros__parameters:
61+
controller_plugins: ["follow_path"]
62+
follow_path:
63+
plugin: "nav2_mppi_controller::MPPIController"
64+
65+
.. code-block:: yaml
66+
67+
collision_monitor:
68+
ros__parameters:
69+
polygons: ["footprint_approach"]
70+
footprint_approach:
71+
type: "polygon"
72+
73+
.. group-tab:: Kilted
74+
75+
.. code-block:: yaml
76+
77+
controller_server:
78+
ros__parameters:
79+
controller_plugins: ["FollowPath"]
80+
FollowPath:
81+
plugin: "nav2_mppi_controller::MPPIController"
82+
83+
.. code-block:: yaml
84+
85+
collision_monitor:
86+
ros__parameters:
87+
polygons: ["FootprintApproach"]
88+
FootprintApproach:
89+
type: "polygon"
6890
6991
An example of a complete configuration can be found in
7092
`nav2_params.yaml <https://github.com/ros-navigation/navigation2/blob/main/nav2_bringup/params/nav2_params.yaml>`_ file.
@@ -106,12 +128,25 @@ The behavior tree XML configuration files may require updating the following nam
106128

107129
An example for updated XML configuration file:
108130

109-
.. code-block:: xml
131+
.. tabs::
132+
133+
.. group-tab:: Lyrical
110134

111-
...
112-
<ControllerSelector selected_controller="{selected_controller}" default_controller="follow_path" topic_name="controller_selector"/>
113-
<PlannerSelector selected_planner="{selected_planner}" default_planner="grid_based" topic_name="planner_selector"/>
114-
...
135+
.. code-block:: xml
136+
137+
...
138+
<ControllerSelector selected_controller="{selected_controller}" default_controller="follow_path" topic_name="controller_selector"/>
139+
<PlannerSelector selected_planner="{selected_planner}" default_planner="grid_based" topic_name="planner_selector"/>
140+
...
141+
142+
.. group-tab:: Kilted
143+
144+
.. code-block:: xml
145+
146+
...
147+
<ControllerSelector selected_controller="{selected_controller}" default_controller="FollowPath" topic_name="controller_selector"/>
148+
<PlannerSelector selected_planner="{selected_planner}" default_planner="GridBased" topic_name="planner_selector"/>
149+
...
115150
116151
The full configuration can be found in
117152
`navigate_to_pose_w_replanning_and_recovery.xml
@@ -129,17 +164,35 @@ Additionally, some BT Action Nodes have new default values in the `nav2_tree_nod
129164
| FollowPath | follow_path |
130165
+------------+--------------------+
131166

132-
.. code-block:: xml
167+
.. tabs::
133168

134-
<Action ID="SmoothPath">
135-
<input_port name="smoother_id" default="smooth_path"/>
136-
...
137-
</Action>
169+
.. group-tab:: Lyrical
138170

139-
<Action ID="FollowPath">
140-
<input_port name="controller_id" default="follow_path"/>
141-
...
142-
</Action>
171+
.. code-block:: xml
172+
173+
<Action ID="SmoothPath">
174+
<input_port name="smoother_id" default="smooth_path"/>
175+
...
176+
</Action>
177+
178+
<Action ID="FollowPath">
179+
<input_port name="controller_id" default="follow_path"/>
180+
...
181+
</Action>
182+
183+
.. group-tab:: Kilted
184+
185+
.. code-block:: xml
186+
187+
<Action ID="SmoothPath">
188+
<input_port name="smoother_id" default="SmoothPath"/>
189+
...
190+
</Action>
191+
192+
<Action ID="FollowPath">
193+
<input_port name="controller_id" default="FollowPath"/>
194+
...
195+
</Action>
143196
144197
New Nav2 ROS Common & Nav2 Lifecycle Node
145198
-----------------------------------------

0 commit comments

Comments
 (0)