Skip to content

Commit a3b53f5

Browse files
authored
IKFast: Fix description of free link -> free joint (#725)
1 parent 2cd5be0 commit a3b53f5

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

doc/ikfast/ikfast_tutorial.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,12 @@ Set the base link and EEF link to the desired index::
194194
export BASE_LINK="0"
195195
export EEF_LINK="8"
196196

197-
If you have a 7 DOF arm you will need to specify a free joint. Selecting the correct free joint for a 7 DOF robot can have significant impact on performance of your kinematics plugin. We suggest experimenting with different choices for the free joint ::
197+
If you have a 7 DOF arm you will need to specify a free joint. Selecting the correct free joint for a 7 DOF robot can have significant impact on performance of your kinematics plugin. Typically, the elbow joint should *not* be used as the free joint. We suggest experimenting with different choices for the free joint.
198+
To this end, figure out the desired joint index first::
199+
200+
openrave-robot.py "$MYROBOT_NAME".dae --info joints
201+
202+
and then store this index as an environment variable for later use::
198203

199204
export FREE_INDEX="1"
200205

@@ -209,16 +214,12 @@ For a 6DOF arm: ::
209214

210215
python `openrave-config --python-dir`/openravepy/_openravepy_/ikfast.py --robot="$MYROBOT_NAME".dae --iktype=transform6d --baselink="$BASE_LINK" --eelink="$EEF_LINK" --savefile="$IKFAST_OUTPUT_PATH"
211216

212-
For a 7 dof arm, you will need to specify a free link: ::
217+
For a 7 dof arm, you also specify the free joint::
213218

214219
python `openrave-config --python-dir`/openravepy/_openravepy_/ikfast.py --robot="$MYROBOT_NAME".dae --iktype=transform6d --baselink="$BASE_LINK" --eelink="$EEF_LINK" --freeindex="$FREE_INDEX" --savefile="$IKFAST_OUTPUT_PATH"
215220

216221
The speed and success of this process will depend on the complexity of your robot. A typical 6 DOF manipulator with 3 intersecting axis at the base or wrist will take only a few minutes to generate the IK.
217222

218-
**Known issue**
219-
--freeindex argument is known to have a bug that it cannot handle tree index correctly.
220-
Say --baselink=2 --eelink=16 and links index from 3 to 9 is not related to current planning group chain. In that case --freeindex will expect index 2 as link 2, but index 3 as link 10 ... and index 9 as link 16.
221-
222223
You should consult the OpenRAVE mailing list and ROS Answers for information about 5 and 7 DOF manipulators.
223224

224225
Create Plugin

0 commit comments

Comments
 (0)