From 7ea83712294d0cf32b8cb8fb6b2c40fc84767c26 Mon Sep 17 00:00:00 2001 From: AndyZe Date: Thu, 15 Dec 2022 10:39:40 -0600 Subject: [PATCH] Default to Cyclone DDS, remove deprecated time-param algorithms (#519) * Recommend Cyclone DDS * Remove mentions of deprecated time-param algorithms Co-authored-by: Jafar --- .../time_parameterization_tutorial.rst | 10 ++-------- doc/tutorials/getting_started/getting_started.rst | 9 +++++++++ .../quickstart_in_rviz/quickstart_in_rviz_tutorial.rst | 2 +- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/examples/time_parameterization/time_parameterization_tutorial.rst b/doc/examples/time_parameterization/time_parameterization_tutorial.rst index 73d2340267..418c1e26c7 100644 --- a/doc/examples/time_parameterization/time_parameterization_tutorial.rst +++ b/doc/examples/time_parameterization/time_parameterization_tutorial.rst @@ -16,17 +16,11 @@ The speed of a parameterized kinematic trajectory can also be modified during ru Time Parameterization Algorithms -------------------------------- -MoveIt can support different algorithms for post-processing a kinematic trajectory to add timestamps and velocity/acceleration values. Currently there are three available by default in MoveIt: +MoveIt can support different algorithms for post-processing a kinematic trajectory to add timestamps and velocity/acceleration values. Currently there is only one option in MoveIt: -* :moveit_codedir:`Iterative Parabolic Time Parameterization` -* :moveit_codedir:`Iterative Spline Parameterization` * :moveit_codedir:`Time-optimal Trajectory Generation` -Iterative Parabolic Time Parameterization (IPTP) was MoveIt's initial time parameterization algorithm. However, there is a known `bug with it `_. - -The Iterative Spline Time Parameterization (ISTP) algorithm was merged with `PR 382 `_. - -Time-optimal Trajectory Generation (TOTG) introduced in PRs `#809 `_ and `#1365 `_ produces trajectories with very smooth and continuous velocity profiles. The method is based on fitting path segments to the original trajectory and then sampling new waypoints from the optimized path. This is different from strict time parameterization methods as resulting waypoints may divert from the original trajectory within a certain tolerance. As a consequence, additional collision checks might be required when using this method. It is the default everywhere in MoveIt2. +Time-optimal Trajectory Generation (TOTG) was introduced in PRs `#809 `_ and `#1365 `_. It produces trajectories with very smooth and continuous velocity profiles. The method is based on fitting path segments to the original trajectory and then sampling new waypoints from the optimized path. This is different from strict time parameterization methods as resulting waypoints may divert from the original trajectory within a certain tolerance. As a consequence, additional collision checks might be required when using this method. It is the default everywhere in MoveIt2. Usage of a time parameterization algorithm as a Planning Request Adapter is documented in `this tutorial <../motion_planning_pipeline/motion_planning_pipeline_tutorial.html#using-a-planning-request-adapter>`_. diff --git a/doc/tutorials/getting_started/getting_started.rst b/doc/tutorials/getting_started/getting_started.rst index 86b6ba0c59..58c4c24e4f 100644 --- a/doc/tutorials/getting_started/getting_started.rst +++ b/doc/tutorials/getting_started/getting_started.rst @@ -85,6 +85,15 @@ Optional: add the previous command to your ``.bashrc``: :: not required and often skipped by advanced users who use more than one Colcon workspace at a time, but we recommend it for simplicity. +Switch to Cyclone DDS +^^^^^^^^^^^^^^^^^^^^^ + +As of Sep 26, 2022, the default ROS2 DDS has an issue. As a workaround, switch to Cyclone. (Note: this makes all nodes started using this RMW incompatible with any other nodes not using Cyclone DDS.) + + sudo apt install ros-rolling-rmw-cyclonedds-cpp + # You may want to add this to ~/.bashrc to source it automatically + export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp + Next Step ^^^^^^^^^ Nice job! Next we will :doc:`Visualize a robot with the interactive motion planning plugin for RViz ` diff --git a/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst b/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst index 8874b2fce2..1b36fecdba 100644 --- a/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst +++ b/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst @@ -7,7 +7,7 @@ This tutorial will teach you how to create motion plans in MoveIt using RViz and Getting Started --------------- -If you haven't already done so, make sure you've completed the steps in :doc:`Getting Started `. +If you haven't already done so, make sure you've completed the steps in :doc:`Getting Started ` or our :doc:`Docker Guide `. As of Sep 26, 2022, ensure you have enabled Cyclone DDS as described there. Step 1: Launch the Demo and Configure the Plugin ------------------------------------------------