Skip to content

Commit a8c57d3

Browse files
authored
Improve IKfast tutorial (#648)
- Use MYROBOT_NAME=panda as the package is called panda_moveit_config - Fix name of solver plugin package - Add a note about WSL2 usage
1 parent ccba270 commit a8c57d3

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/ikfast/ikfast_tutorial.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The following command will ensure that you can run docker with your user account
4242

4343
You need to log off/log on in order to actually activate this permission change.
4444

45+
Note: To run docker from `WSL2 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_, you need to install the `Docker Desktop WSL 2 backend <https://docs.docker.com/docker-for-windows/wsl>`_.
46+
4547
Install the MoveIt IKFast package either from Debian packages or from source.
4648

4749
**Binary Install**: ::
@@ -61,7 +63,7 @@ Creating the IKFast MoveIt plugin
6163

6264
To facilitate copy-and-paste, we suggest to define the robot name as an environment variable: ::
6365

64-
export MYROBOT_NAME="panda_arm"
66+
export MYROBOT_NAME="panda"
6567

6668
OpenRAVE uses Collada instead of URDF to describe the robot. In order to automatically convert your robot's URDF to Collada, you need to provide the .urdf file.
6769
If your .urdf file is generated from `xacro <http://wiki.ros.org/xacro/>`_ files, you can generate the URDF using the following command: ::
@@ -85,6 +87,7 @@ To generate the IKFast MoveIt plugin, issue the following command: ::
8587

8688
rosrun moveit_kinematics auto_create_ikfast_moveit_plugin.sh --iktype Transform6D $MYROBOT_NAME.urdf <planning_group_name> <base_link> <eef_link>
8789

90+
Replace the last three positional parameters with the correct ``planning_group_name`` as well as the names of the base link and the end-effector link of your robot.
8891
The speed and success of this process will depend on the complexity of your robot. A typical 6 DOF manipulator with 3 intersecting axes at the base or wrist will take only a few minutes to generate the solver code. For a detailed explanation of the creation procedure and additional tweaks of the process, see `Tweaking the creation process`_.
8992

9093
The command above creates a new ROS package named ``$MYROBOT_NAME_<planning_group_name>_ikfast_plugin`` within the current folder.
@@ -101,11 +104,13 @@ The IKFast plugin can be used as a drop-in replacement for the default KDL IK So
101104
Edit these parts: ::
102105

103106
<planning_group>:
104-
kinematics_solver: <myrobot_name>_<planning_group>_ikfast_plugin/IKFastKinematicsPlugin
107+
kinematics_solver: <myrobot_name>_<planning_group>/IKFastKinematicsPlugin
105108

106109
Test the Plugin
107110
^^^^^^^^^^^^^^^
108-
Use the MoveIt RViz Motion Planning Plugin and use the interactive markers to see if correct IK Solutions are found.
111+
Use the MoveIt RViz Motion Planning Plugin and use the interactive markers to see if correct IK Solutions are found: ::
112+
113+
roslaunch "$MYROBOT_NAME"_moveit_config demo.launch
109114

110115
Updating the Plugin
111116
-------------------

0 commit comments

Comments
 (0)