create_ikfast_moveit_plugin.py

#! /usr/bin/env python
from __future__ import print_function

"""
IKFast Plugin Generator for MoveIt

Creates a kinematics plugin using the output of IKFast from OpenRAVE.
This plugin and the move_group node can be used as a general
kinematics service, from within the moveit planning environment, or in
your own ROS node.

Author: Dave Coleman, PickNik Inc.
        Michael Lautman, PickNik Inc.
        Based heavily on the arm_kinematic_tools package by Jeremy Zoss, SwRI
        and the arm_navigation plugin generator by David Butterworth, KAIST

Date: March 2013

"""
"""
Copyright (c) 2013, Jeremy Zoss, SwRI
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Willow Garage, Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
IABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
"""

import re
import os
import yaml
from lxml import etree
from getpass import getuser
import shutil
import argparse

try:
    from ament_index_python.packages import (
        get_package_share_directory,
        PackageNotFoundError,
    )
except ImportError:
    print(
        "Failed to import ament_index_python. No ROS2 environment available? Trying without."
    )

    # define stubs
    class PackageNotFoundError(Exception):
        pass

    def get_package_share_directory(pkg_name):
        raise PackageNotFoundError


# Package containing this file
plugin_gen_pkg = "moveit_kinematics"
# Allowed search modes, see SEARCH_MODE enum in template file
search_modes = ["OPTIMIZE_MAX_JOINT", "OPTIMIZE_FREE_JOINT"]


def create_parser():
    parser = argparse.ArgumentParser(
        description="Generate an IKFast MoveIt kinematic plugin"
    )
    parser.add_argument("robot_name", help="The name of your robot")
    parser.add_argument(
        "planning_group_name",
        help="The name of the planning group for which your IKFast solution was generated",
    )
    parser.add_argument(
        "ikfast_plugin_pkg",
        help="The name of the MoveIt IKFast Kinematics Plugin to be created/updated",
    )
    parser.add_argument(
        "base_link_name",
        help="The name of the base link that was used when generating your IKFast solution",
    )
    parser.add_argument(
        "eef_link_name",
        help="The name of the end effector link that was used when generating your IKFast solution",
    )
    parser.add_argument(
        "ikfast_output_path",
        help="The full path to the analytic IK solution output by IKFast",
    )
    parser.add_argument(
        "--search_mode",
        default=search_modes[0],
        help="The search mode used to solve IK for robots with more than 6DOF",
    )
    parser.add_argument(
        "--srdf_filename", help="The name of your robot. Defaults to <robot_name>.srdf"
    )
    parser.add_argument(
        "--robot_name_in_srdf",
        help="The name of your robot as defined in the srdf. Defaults to <robot_name>",
    )
    parser.add_argument(
        "--moveit_config_pkg",
        help="The robot moveit_config package. Defaults to <robot_name>_moveit_config",
    )
    return parser


def populate_optional(args):
    if args.srdf_filename is None:
        args.srdf_filename = args.robot_name + ".srdf"
    if args.robot_name_in_srdf is None:
        args.robot_name_in_srdf = args.robot_name
    if args.moveit_config_pkg is None:
        args.moveit_config_pkg = args.robot_name + "_moveit_config"


def print_args(args):
    print("Creating IKFastKinematicsPlugin with parameters: ")
    print(" robot_name:           %s" % args.robot_name)
    print(" base_link_name:       %s" % args.base_link_name)
    print(" eef_link_name:        %s" % args.eef_link_name)
    print(" planning_group_name:  %s" % args.planning_group_name)
    print(" ikfast_plugin_pkg:    %s" % args.ikfast_plugin_pkg)
    print(" ikfast_output_path:   %s" % args.ikfast_output_path)
    print(" search_mode:          %s" % args.search_mode)
    print(" srdf_filename:        %s" % args.srdf_filename)
    print(" robot_name_in_srdf:   %s" % args.robot_name_in_srdf)
    print(" moveit_config_pkg:    %s" % args.moveit_config_pkg)
    print("")


def update_deps(reqd_deps, req_type, e_parent):
    curr_deps = [e.text for e in e_parent.findall(req_type)]
    missing_deps = set(reqd_deps) - set(curr_deps)
    for dep in missing_deps:
        etree.SubElement(e_parent, req_type).text = dep


def validate_openrave_version(args):
    if not os.path.exists(args.ikfast_output_path):
        raise Exception("Can't find IKFast source code at " + args.ikfast_output_path)

    # Detect version of IKFast used to generate solver code
    solver_version = 0
    with open(args.ikfast_output_path, "r") as src:
        for line in src:
            if line.startswith("/// ikfast version"):
                line_search = re.search("ikfast version (.*) generated", line)
                if line_search:
                    solver_version = int(line_search.group(1), 0) & ~0x10000000
                break
    print("Found source code generated by IKFast version %s" % str(solver_version))

    # Chose template depending on IKFast version
    if solver_version >= 56:
        setattr(args, "template_version", 61)
    else:
        raise Exception("This converter requires IKFast 0.5.6 or newer.")


def xmlElement(name, text=None, **attributes):
    e = etree.Element(name, **attributes)
    e.text = text
    return e


def create_parameter_dict():
    parameter_dict = {
        "ikfast_kinematics": {
            "link_prefix": {
                "default_value": "",
                "type": "string",
                "description": "prefix added to tip- and baseframe to allow different namespaces or multi-robot setups",
            }
        }
    }
    return parameter_dict


def create_ikfast_package(args):
    try:
        setattr(
            args,
            "ikfast_plugin_pkg_path",
            get_package_share_directory(args.ikfast_plugin_pkg),
        )
    except PackageNotFoundError:
        args.ikfast_plugin_pkg_path = os.path.abspath(args.ikfast_plugin_pkg)
        print(
            "Failed to find package: %s. Will create it in %s."
            % (args.ikfast_plugin_pkg, args.ikfast_plugin_pkg_path)
        )
        # update pkg name to basename of path
        args.ikfast_plugin_pkg = os.path.basename(args.ikfast_plugin_pkg_path)

    src_path = args.ikfast_plugin_pkg_path + "/src/"
    if not os.path.exists(src_path):
        os.makedirs(src_path)

    include_path = args.ikfast_plugin_pkg_path + "/include/"
    if not os.path.exists(include_path):
        os.makedirs(include_path)

    # Create package.xml
    pkg_xml_path = args.ikfast_plugin_pkg_path + "/package.xml"
    if not os.path.exists(pkg_xml_path):
        root = xmlElement("package", format="2")
        root.append(xmlElement("name", text=args.ikfast_plugin_pkg))
        root.append(xmlElement("version", text="0.0.0"))
        root.append(
            xmlElement("description", text="IKFast plugin for " + args.robot_name)
        )
        root.append(xmlElement("license", text="BSD"))
        user_name = getuser()
        root.append(
            xmlElement("maintainer", email="%s@todo.todo" % user_name, text=user_name)
        )
        root.append(xmlElement("buildtool_depend", text="ament_cmake"))
        export = xmlElement("export")
        export.append(xmlElement("build_type", text="ament_cmake"))
        root.append(export)
        etree.ElementTree(root).write(
            pkg_xml_path, xml_declaration=True, pretty_print=True, encoding="UTF-8"
        )
        print("Created package.xml at: '%s'" % pkg_xml_path)

    # Create parameter YAML in src folder
    parameters_yaml_path = src_path + "ikfast_kinematics_parameters.yaml"
    if not os.path.exists(parameters_yaml_path):
        print("Create parameters.yaml at: '%s'" % parameters_yaml_path)
        with open(parameters_yaml_path, "w") as file:
            documents = yaml.dump(create_parameter_dict(), file)


def find_template_dir():
    for candidate in [os.path.dirname(__file__) + "/../templates"]:
        if os.path.exists(candidate) and os.path.exists(candidate + "/ikfast.h"):
            return os.path.realpath(candidate)
    try:
        return os.path.join(
            get_package_share_directory(plugin_gen_pkg),
            "ikfast_kinematics_plugin/templates",
        )
    except PackageNotFoundError:
        raise Exception("Can't find package %s" % plugin_gen_pkg)


def update_ikfast_package(args):
    # Copy the source code generated by IKFast into our src folder
    src_path = args.ikfast_plugin_pkg_path + "/src/"
    solver_file_path = (
        src_path
        + args.robot_name
        + "_"
        + args.planning_group_name
        + "_ikfast_solver.cpp"
    )
    if not os.path.exists(solver_file_path) or not os.path.samefile(
        args.ikfast_output_path, solver_file_path
    ):
        shutil.copy2(args.ikfast_output_path, solver_file_path)

    if not os.path.exists(solver_file_path):
        raise Exception(
            "Failed to copy IKFast source code from '%s' to '%s'\n"
            "Manually copy the source file generated by IKFast to this location and re-run"
            % (args.ikfast_output_path, solver_file_path)
        )
    # Remember ikfast solver file for update of MoveIt package
    args.ikfast_output_path = solver_file_path

    # Get template folder location
    template_dir = find_template_dir()

    # namespace for the plugin
    setattr(args, "namespace", args.robot_name + "_" + args.planning_group_name)
    replacements = dict(
        _ROBOT_NAME_=args.robot_name,
        _GROUP_NAME_=args.planning_group_name,
        _SEARCH_MODE_=args.search_mode,
        _EEF_LINK_=args.eef_link_name,
        _BASE_LINK_=args.base_link_name,
        _PACKAGE_NAME_=args.ikfast_plugin_pkg,
        _NAMESPACE_=args.namespace,
    )

    # Copy ikfast header file
    copy_file(
        template_dir + "/ikfast.h",
        args.ikfast_plugin_pkg_path + "/include/ikfast.h",
        "ikfast header file",
    )
    # Create ikfast plugin template
    copy_file(
        template_dir
        + "/ikfast"
        + str(args.template_version)
        + "_moveit_plugin_template.cpp",
        args.ikfast_plugin_pkg_path
        + "/src/"
        + args.robot_name
        + "_"
        + args.planning_group_name
        + "_ikfast_moveit_plugin.cpp",
        "ikfast plugin file",
        replacements,
    )

    # Create plugin definition .xml file
    ik_library_name = args.namespace + "_moveit_ikfast_plugin"
    plugin_def = etree.Element("library", path=ik_library_name)
    setattr(args, "plugin_name", args.namespace + "/IKFastKinematicsPlugin")
    cl = etree.SubElement(
        plugin_def,
        "class",
        name=args.plugin_name,
        type=args.namespace + "::IKFastKinematicsPlugin",
        base_class_type="kinematics::KinematicsBase",
    )
    desc = etree.SubElement(cl, "description")
    desc.text = (
        "IKFast{template} plugin for closed-form kinematics of {robot} {group}".format(
            template=args.template_version,
            robot=args.robot_name,
            group=args.planning_group_name,
        )
    )

    # Write plugin definition to file
    plugin_file_name = ik_library_name + "_description.xml"
    plugin_file_path = args.ikfast_plugin_pkg_path + "/" + plugin_file_name
    etree.ElementTree(plugin_def).write(
        plugin_file_path, xml_declaration=True, pretty_print=True, encoding="UTF-8"
    )
    print("Created plugin definition at  '%s'" % plugin_file_path)

    # Create CMakeLists file
    replacements.update(dict(_LIBRARY_NAME_=ik_library_name))
    copy_file(
        template_dir + "/CMakeLists.txt",
        args.ikfast_plugin_pkg_path + "/CMakeLists.txt",
        "cmake file",
        replacements,
    )

    # Add plugin export to package manifest
    parser = etree.XMLParser(remove_blank_text=True)
    package_file_name = args.ikfast_plugin_pkg_path + "/package.xml"
    package_xml = etree.parse(package_file_name, parser).getroot()

    # Make sure at least all required dependencies are in the depends lists
    build_deps = [
        "liblapack-dev",
        "moveit_core",
        "pluginlib",
        "rclcpp",
        "tf2_kdl",
        "tf2_eigen",
    ]
    run_deps = ["liblapack-dev", "moveit_core", "pluginlib", "rclcpp"]

    update_deps(build_deps, "build_depend", package_xml)
    update_deps(run_deps, "exec_depend", package_xml)

    # Check that plugin definition file is in the export list
    new_export = etree.Element("moveit_core", plugin="${prefix}/" + plugin_file_name)

    export_element = package_xml.find("export")
    if export_element is None:
        export_element = etree.SubElement(package_xml, "export")

    found = False
    for el in export_element.findall("moveit_core"):
        found = etree.tostring(new_export) == etree.tostring(el)
        if found:
            break

    if not found:
        export_element.append(new_export)

    # Always write the package xml file, even if there are no changes, to ensure
    # proper encodings are used in the future (UTF-8)
    etree.ElementTree(package_xml).write(
        package_file_name, xml_declaration=True, pretty_print=True, encoding="UTF-8"
    )
    print("Wrote package.xml at  '%s'" % package_file_name)

    # Create a script for easily updating the plugin in the future in case the plugin needs to be updated
    easy_script_file_path = args.ikfast_plugin_pkg_path + "/update_ikfast_plugin.sh"
    with open(easy_script_file_path, "w") as f:
        f.write(
            "search_mode="
            + args.search_mode
            + "\n"
            + "srdf_filename="
            + args.srdf_filename
            + "\n"
            + "robot_name_in_srdf="
            + args.robot_name_in_srdf
            + "\n"
            + "moveit_config_pkg="
            + args.moveit_config_pkg
            + "\n"
            + "robot_name="
            + args.robot_name
            + "\n"
            + "planning_group_name="
            + args.planning_group_name
            + "\n"
            + "ikfast_plugin_pkg="
            + args.ikfast_plugin_pkg
            + "\n"
            + "base_link_name="
            + args.base_link_name
            + "\n"
            + "eef_link_name="
            + args.eef_link_name
            + "\n"
            + "ikfast_output_path="
            + args.ikfast_output_path
            + "\n\n"
            + "rosrun moveit_kinematics create_ikfast_moveit_plugin.py\\\n"
            + "  --search_mode=$search_mode\\\n"
            + "  --srdf_filename=$srdf_filename\\\n"
            + "  --robot_name_in_srdf=$robot_name_in_srdf\\\n"
            + "  --moveit_config_pkg=$moveit_config_pkg\\\n"
            + "  $robot_name\\\n"
            + "  $planning_group_name\\\n"
            + "  $ikfast_plugin_pkg\\\n"
            + "  $base_link_name\\\n"
            + "  $eef_link_name\\\n"
            + "  $ikfast_output_path\n"
        )

    print("Created update plugin script at '%s'" % easy_script_file_path)


def update_moveit_package(args):
    try:
        moveit_config_pkg_path = get_package_share_directory(args.moveit_config_pkg)
    except PackageNotFoundError:
        raise Exception("Failed to find package: " + args.moveit_config_pkg)

    try:
        srdf_file_name = moveit_config_pkg_path + "/config/" + args.srdf_filename
        srdf = etree.parse(srdf_file_name).getroot()
    except IOError:
        raise Exception("Failed to find SRDF file: " + srdf_file_name)
    except etree.XMLSyntaxError as err:
        raise Exception(
            "Failed to parse xml in file: %s\n%s" % (srdf_file_name, err.msg)
        )

    if args.robot_name_in_srdf != srdf.get("name"):
        raise Exception(
            "Robot name in srdf ('%s') doesn't match expected name ('%s')"
            % (srdf.get("name"), args.robot_name_in_srdf)
        )

    groups = srdf.findall("group")
    if len(groups) < 1:
        raise Exception("No planning groups are defined in the SRDF")

    planning_group = None
    for group in groups:
        if group.get("name").lower() == args.planning_group_name.lower():
            planning_group = group

    if planning_group is None:
        raise Exception(
            "Planning group '%s' not defined in the SRDF. Available groups: \n%s"
            % (
                args.planning_group_name,
                ", ".join([group_name.get("name") for group_name in groups]),
            )
        )

    # Modify kinematics.yaml file
    kin_yaml_file_name = moveit_config_pkg_path + "/config/kinematics.yaml"
    with open(kin_yaml_file_name, "r") as f:
        kin_yaml_data = yaml.safe_load(f)

    kin_yaml_data[args.planning_group_name]["kinematics_solver"] = args.plugin_name
    with open(kin_yaml_file_name, "w") as f:
        yaml.dump(kin_yaml_data, f, default_flow_style=False)

    print("Modified kinematics.yaml at '%s'" % kin_yaml_file_name)


def copy_file(src_path, dest_path, description, replacements=None):
    if not os.path.exists(src_path):
        raise Exception("Can't find %s at '%s'" % (description, src_path))

    if replacements is None:
        replacements = dict()

    with open(src_path, "r") as f:
        content = f.read()

    # replace templates
    for key, value in replacements.items():
        content = re.sub(key, value, content)

    with open(dest_path, "w") as f:
        f.write(content)
    print("Created %s at '%s'" % (description, dest_path))


def main():
    parser = create_parser()
    args = parser.parse_args()

    populate_optional(args)
    print_args(args)
    validate_openrave_version(args)
    create_ikfast_package(args)
    update_ikfast_package(args)
    try:
        update_moveit_package(args)
    except Exception as e:
        print("Failed to update MoveIt package:\n" + str(e))


if __name__ == "__main__":
    main()