Skip to content

Commit

Permalink
[MSA] ros2_control Integration (#1299)
Browse files Browse the repository at this point in the history
* Modified URDF Infrastructure

* Control Xacro Config

* URDF Modifications Widget

* Use same base class for ROS2Controllers and MoveItControllers (widget/config/setup_step)

* Further cleanup

* Fix ModifiedURDF Generation

* Apply suggestions from code review

Co-authored-by: AndyZe <andyz@utexas.edu>

* Rename button variable

* Clang line length fix

Co-authored-by: AndyZe <andyz@utexas.edu>
  • Loading branch information
DLu and AndyZe committed Jun 14, 2022
1 parent 5608368 commit 087664b
Show file tree
Hide file tree
Showing 38 changed files with 2,497 additions and 666 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,16 @@ def __init__(
self.__urdf_file_path = None
self.__srdf_file_path = None

modified_urdf_path = Path("config") / (self.__robot_name + ".urdf.xacro")
if (self._package_path / modified_urdf_path).exists():
self.__urdf_package = self._package_path
self.__urdf_file_path = modified_urdf_path

if setup_assistant_file.exists():
setup_assistant_yaml = load_yaml(setup_assistant_file)
config = setup_assistant_yaml.get("moveit_setup_assistant_config", {})
urdf_config = config.get("urdf", config.get("URDF"))
if urdf_config:
if urdf_config and self.__urdf_package is None:
self.__urdf_package = Path(
get_package_share_directory(urdf_config["package"])
)
Expand Down
4 changes: 3 additions & 1 deletion moveit_setup_assistant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@
* `moveit_setup::srdf_setup::RobotPosesWidget`
* `moveit_setup::srdf_setup::EndEffectorsWidget`
* `moveit_setup::srdf_setup::PassiveJointsWidget`
* `moveit_setup::controllers::UrdfModificationsWidget`
* `moveit_setup::controllers::ROS2ControllersWidget`
* `moveit_setup::controllers::MoveItControllersWidget`
* `moveit_setup::app::PerceptionWidget`
* `moveit_setup::app::LaunchesWidget`
* `moveit_setup::core::AuthorInformationWidget`
* `moveit_setup::core::ConfigurationFilesWidget`

### Not Ported Yet
* `moveit_setup::controllers::ControllersWidget`
* `moveit_setup::simulation::SimulationWidget`

### Notes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ SetupAssistantWidget::SetupAssistantWidget(rviz_common::ros_integration::RosNode
setup_steps.push_back("moveit_setup::srdf_setup::RobotPosesWidget");
setup_steps.push_back("moveit_setup::srdf_setup::EndEffectorsWidget");
setup_steps.push_back("moveit_setup::srdf_setup::PassiveJointsWidget");
setup_steps.push_back("moveit_setup::controllers::ControllersWidget");
setup_steps.push_back("moveit_setup::controllers::UrdfModificationsWidget");
setup_steps.push_back("moveit_setup::controllers::ROS2ControllersWidget");
setup_steps.push_back("moveit_setup::controllers::MoveItControllersWidget");
// setup_steps.push_back("moveit_setup::simulation::SimulationWidget");
setup_steps.push_back("moveit_setup::app::PerceptionWidget");
setup_steps.push_back("moveit_setup::app::LaunchesWidget");
Expand Down
15 changes: 14 additions & 1 deletion moveit_setup_assistant/moveit_setup_controllers/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,22 @@ add_definitions(-DQT_NO_KEYWORDS)
qt5_wrap_cpp(MOC_FILES
include/moveit_setup_controllers/controller_edit_widget.hpp
include/moveit_setup_controllers/controllers_widget.hpp
include/moveit_setup_controllers/urdf_modifications_widget.hpp
)

add_library(${PROJECT_NAME}
src/control_xacro_config.cpp
src/controller_edit_widget.cpp
src/controllers.cpp
src/controllers_widget.cpp
src/controller_config.cpp
src/controllers_config.cpp
src/modified_urdf_config.cpp
src/moveit_controllers_config.cpp
src/moveit_controllers_widget.cpp
src/ros2_controllers_config.cpp
src/ros2_controllers_widget.cpp
src/urdf_modifications.cpp
src/urdf_modifications_widget.cpp
${MOC_FILES}
)
target_include_directories(${PROJECT_NAME} PUBLIC
Expand Down Expand Up @@ -58,6 +67,10 @@ install(FILES moveit_setup_framework_plugins.xml
install(DIRECTORY include/
DESTINATION include
)

install(DIRECTORY launch
DESTINATION share/${PROJECT_NAME}
)
ament_export_include_directories(include)

ament_export_libraries(${PROJECT_NAME})
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
/*********************************************************************
* Software License Agreement (BSD License)
*
* Copyright (c) 2022, Metro Robots
* 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 Metro Robots 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 LIABLE 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.
*********************************************************************/

/* Author: David V. Lu!! */

#pragma once

#include <moveit_setup_controllers/modified_urdf_config.hpp>
#include <moveit_setup_framework/data/srdf_config.hpp>

namespace moveit_setup
{
namespace controllers
{
struct ControlInterfaces
{
std::vector<std::string> command_interfaces;
std::vector<std::string> state_interfaces;
};

inline std::vector<std::string> getAvailableInterfaceNames()
{
return { "position", "velocity", "effort" };
}

class ControlXacroConfig : public IncludedXacroConfig
{
public:
/**@name SetupConfig overrides */
/**@{*/
void onInit() override;
void loadPrevious(const std::filesystem::path& /*config_package_path*/, const YAML::Node& node) override;
YAML::Node saveToYaml() const override;
bool isConfigured() const override;
/**@}*/

/**@name IncludedXacroConfig overrides */
/**@{*/
std::string getFilepath() const override;
bool hasChanges() const override;
std::vector<std::pair<std::string, std::string>> getArguments() const override;
std::vector<std::string> getCommands() const override;
/**@}*/

/**
* @brief Load the original command interfaces from the original (unmodified) URDF
*
* Needs to be run whenever the URDF/SRDF may have changed
*/
void loadFromDescription();

bool hasAllControlTagsInOriginal() const;

/**@name Data access and modification */
/**@{*/

const ControlInterfaces& getAvailableControlInterfaces() const
{
return available_ci_;
}

const ControlInterfaces& getDefaultControlInterfaces() const
{
return default_ci_;
}

/**
* @brief Use the specified controller interfaces for all the lacking joints
*/
void setControlInterfaces(const ControlInterfaces& ci);

/**
* @brief Get all the control interfaces for all of the specified joint names
*/
const ControlInterfaces getControlInterfaces(const std::vector<std::string>& joint_names) const;

/**@}*/

/**
* @brief Return the additional joint xml needed for ros2_control tags
*/
std::string getJointsXML() const;

class GeneratedControlHeader : public TemplatedGeneratedFile
{
public:
GeneratedControlHeader(const std::filesystem::path& package_path, const GeneratedTime& last_gen_time,
ControlXacroConfig& parent)
: TemplatedGeneratedFile(package_path, last_gen_time), parent_(parent)
{
}

std::filesystem::path getRelativePath() const override
{
return std::filesystem::path("config") / (parent_.urdf_config_->getRobotName() + ".ros2_control.xacro");
}

std::filesystem::path getTemplatePath() const override
{
return getSharePath("moveit_setup_controllers") / "templates" / "config" / "ros2_control.xacro";
}

std::string getDescription() const override
{
return "Macro definition for required ros2_control xacro additions.";
}

bool hasChanges() const override
{
return parent_.hasChanges();
}

protected:
ControlXacroConfig& parent_;
};

class GeneratedInitialPositions : public YamlGeneratedFile
{
public:
GeneratedInitialPositions(const std::filesystem::path& package_path, const GeneratedTime& last_gen_time,
ControlXacroConfig& parent)
: YamlGeneratedFile(package_path, last_gen_time), parent_(parent)
{
}

bool hasChanges() const override
{
return parent_.hasChanges();
}

std::filesystem::path getRelativePath() const override
{
return "config/initial_positions.yaml";
}

std::string getDescription() const override
{
return "Initial positions for ros2_control";
}

bool writeYaml(YAML::Emitter& emitter) override;

protected:
ControlXacroConfig& parent_;
};

void collectFiles(const std::filesystem::path& package_path, const GeneratedTime& last_gen_time,
std::vector<GeneratedFilePtr>& files) override
{
files.push_back(std::make_shared<GeneratedControlHeader>(package_path, last_gen_time, *this));
files.push_back(std::make_shared<GeneratedInitialPositions>(package_path, last_gen_time, *this));
}

void collectVariables(std::vector<TemplateVariable>& variables) override;

protected:
void getControlInterfaces(const std::string& joint_name, ControlInterfaces& ci) const;

std::vector<std::string> joint_names_; /// A list of all joints used by the current SRDF groups
std::unordered_map<std::string, ControlInterfaces> original_joint_interfaces_, new_joint_interfaces_;

ControlInterfaces default_ci_, available_ci_;
srdf::Model::GroupState initial_group_state_;

bool changed_;
};
} // namespace controllers
} // namespace moveit_setup
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ class ControllerEditWidget : public QWidget
// ******************************************************************************************

/// Constructor
ControllerEditWidget(QWidget* parent, Controllers& setup_step);
ControllerEditWidget(QWidget* parent);

/// Set the previous data
void setSelected(const std::string& controller_name);
void setSelected(const std::string& controller_name, const ControllerInfo* info);

/// Populate the combo dropdown box with controllers types
void loadControllersTypesComboBox();
void loadControllersTypesComboBox(const std::vector<std::string>& controller_types);

/// Hide delete controller button
void hideDelete();
Expand Down Expand Up @@ -136,8 +136,6 @@ private Q_SLOTS:

// For loading default types combo box just once
bool has_loaded_ = false;

Controllers& setup_step_;
};
} // namespace controllers
} // namespace moveit_setup
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

#include <moveit_setup_framework/setup_step.hpp>
#include <moveit_setup_framework/data/srdf_config.hpp>
#include <moveit_setup_controllers/controller_config.hpp>
#include <moveit_setup_controllers/controllers_config.hpp>

namespace moveit_setup
{
Expand All @@ -46,12 +46,13 @@ namespace controllers
class Controllers : public SetupStep
{
public:
std::string getName() const override
{
return "Controllers";
}
virtual std::string getInstructions() const = 0;

virtual std::string getButtonText() const = 0;

virtual std::vector<std::string> getAvailableTypes() const = 0;

void onInit() override;
virtual std::string getDefaultType() const = 0;

bool isReady() const override
{
Expand Down
Loading

0 comments on commit 087664b

Please sign in to comment.