diff --git a/plugin_tutorials/docs/writing_new_behavior_plugin.rst b/plugin_tutorials/docs/writing_new_behavior_plugin.rst index 5a3c43093f..285889eedd 100644 --- a/plugin_tutorials/docs/writing_new_behavior_plugin.rst +++ b/plugin_tutorials/docs/writing_new_behavior_plugin.rst @@ -192,8 +192,20 @@ It is good practice to place these lines at the end of the file but technically, -5. Compile and it should be registered. Next, we'll use this plugin. +5. Compile and it should be registered. You can verify that it has been successfully registered by running: +.. code-block:: shell + + $ ros2 plugin list + +You should see an output similar to below: + +.. code-block:: shell + + nav2_sms_behavior: + Plugin(name='nav2_sms_behavior::SendSms', type='nav2_sms_behavior::SendSms', base='nav2_core::Behavior') + +Next, we'll use this plugin. 3- Pass the plugin name through params file ------------------------------------------- diff --git a/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst b/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst index ca91bee20b..75aa8eb827 100644 --- a/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst +++ b/plugin_tutorials/docs/writing_new_costmap2d_plugin.rst @@ -174,7 +174,18 @@ Plugin description file is also should be added to ``package.xml``. ``costmap_2d After everything is done put the plugin package into ``src`` directory of a certain ROS 2-workspace, build the plugin package (``colcon build --packages-select nav2_gradient_costmap_plugin --symlink-install``) and source ``setup.bash`` file when it necessary. -Now the plugin is ready to use. +Now the plugin is ready to use. You can verify that it has been successfully registered by running: + +.. code-block:: shell + + $ ros2 plugin list + +You should see an output similar to below: + +.. code-block:: shell + + nav2_gradient_costmap_plugin: + Plugin(name='nav2_gradient_costmap_plugin::GradientLayer', type='nav2_gradient_costmap_plugin::GradientLayer', base='nav2_costmap_2d::Layer') 3- Enable the plugin in Costmap2D --------------------------------- diff --git a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst index 0ecc50477d..e1d3010b8e 100644 --- a/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst +++ b/plugin_tutorials/docs/writing_new_nav2controller_plugin.rst @@ -251,7 +251,20 @@ It is good practice to place these lines at the end of the file, but technically -5. Compile, and it should be registered. Next, we'll use this plugin. +5. Compile, and it should be registered. You can verify that it has been successfully registered by running: + +.. code-block:: shell + + $ ros2 plugin list + +You should see an output similar to below: + +.. code-block:: shell + + nav2_pure_pursuit_controller: + Plugin(name='nav2_pure_pursuit_controller::PurePursuitController', type='nav2_pure_pursuit_controller::PurePursuitController', base='nav2_core::Controller') + +Next, we'll use this plugin. 3- Pass the plugin name through the params file ----------------------------------------------- diff --git a/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst b/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst index 0402ff126e..8fa6eb00c7 100644 --- a/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst +++ b/plugin_tutorials/docs/writing_new_nav2planner_plugin.rst @@ -183,7 +183,20 @@ It is good practice to place these lines at the end of the file, but technically -5. Compile and it should be registered. Next, we'll use this plugin. +5. Compile and it should be registered. You can verify that it has been successfully registered by running: + +.. code-block:: shell + + $ ros2 plugin list + +You should see an output similar to below: + +.. code-block:: shell + + nav2_straightline_planner: + Plugin(name='nav2_straightline_planner::StraightLine', type='nav2_straightline_planner::StraightLine', base='nav2_core::GlobalPlanner') + +Next, we'll use this plugin. 3- Pass the plugin name through params file ------------------------------------------- diff --git a/plugin_tutorials/docs/writing_new_navigator_plugin.rst b/plugin_tutorials/docs/writing_new_navigator_plugin.rst index 8e6fd0e444..1479abcda6 100644 --- a/plugin_tutorials/docs/writing_new_navigator_plugin.rst +++ b/plugin_tutorials/docs/writing_new_navigator_plugin.rst @@ -310,7 +310,20 @@ It is good practice to place these lines at the end of the file, but technically -5. Compile, and it should be registered. Next, we'll use this plugin. +5. Compile, and it should be registered. You can verify that it has been successfully registered by running: + +.. code-block:: shell + + $ ros2 plugin list + +You should see an output similar to below: + +.. code-block:: shell + + nav2_bt_navigator: + Plugin(name='nav2_bt_navigator::NavigateToPoseNavigator', type='nav2_bt_navigator::NavigateToPoseNavigator', base='nav2_core::NavigatorBase') + +Next, we'll use this plugin. 3- Pass the plugin name through the params file -----------------------------------------------