Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated with ros2-control Foxy API #44

Merged
merged 34 commits into from
Feb 3, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
c94af39
Updated with ros2-control foxy API
ahcorde Jan 11, 2021
b61b137
Fixed dependency
ahcorde Jan 11, 2021
a0ef367
make compile on osx (#46)
Karsten1987 Jan 13, 2021
a69ff7c
Fixed velocity example
ahcorde Jan 13, 2021
868b07a
Merge branch 'ahcorde/update/foxy' of https://github.com/ros-simulati…
ahcorde Jan 13, 2021
02ac826
make linters happy
ahcorde Jan 13, 2021
90a0b6f
updated Dockerfile
ahcorde Jan 15, 2021
2933f8d
Added effort example
ahcorde Jan 15, 2021
7334f06
Instructions to run with moveit2
ahcorde Jan 15, 2021
f5b1acc
updated readme
ahcorde Jan 21, 2021
a9b771a
Added PIMPL pattern and other fixes
ahcorde Jan 21, 2021
973e961
updated Dockerfile
ahcorde Jan 21, 2021
fe3a901
changed log level
ahcorde Jan 21, 2021
436c9f9
Fixed gazebo_period units
ahcorde Jan 22, 2021
45aa6c9
Updated CI
ahcorde Jan 22, 2021
0479a9d
updated CI
ahcorde Jan 22, 2021
6047ae9
updated CI
ahcorde Jan 22, 2021
30a6124
update CI
ahcorde Jan 22, 2021
240de77
updated Dockerfile
ahcorde Jan 22, 2021
f465d60
Added feedback
ahcorde Jan 26, 2021
60e0022
make linters happy
ahcorde Jan 26, 2021
07417e9
Removed PID controllers
ahcorde Jan 28, 2021
31399db
make linters happy
ahcorde Jan 28, 2021
9e5d685
Removed transmission interface
ahcorde Feb 1, 2021
970adeb
Removed e-stop
ahcorde Feb 1, 2021
9af1bfa
make linters happy
ahcorde Feb 1, 2021
2822a9a
clean code
ahcorde Feb 1, 2021
27ecc75
Fix CI
ahcorde Feb 1, 2021
f8b0871
Changed log level of a trace
ahcorde Feb 1, 2021
595ba17
Added rclcpp dependency to gazebo_hardware_plugin
ahcorde Feb 1, 2021
da262d9
Fixed bug in control method
ahcorde Feb 2, 2021
794da79
Support more than one ros2_control tag
ahcorde Feb 2, 2021
f84047f
make linters happy
ahcorde Feb 2, 2021
4889311
unify yaml files
ahcorde Feb 3, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,11 @@ ros2 run gazebo_ros2_control_demos example_position

## Add transmission elements to a URDF

To use `ros2_control` with your robot, you need to add some additional elements to your URDF. The `<transmission>` element is used to link actuators to joints, see the `<transmission>` spec for exact XML format.
To use `ros2_control` with your robot, you need to add some additional elements to your URDF.
The `<transmission>` element is used to link actuators to joints, see the `<transmission>` spec for exact XML format.

For the purposes of `gazebo_ros2_control` in its current implementation, the only important information in these transmission tags are:
For the purposes of `gazebo_ros2_control` in its current implementation, the only important information
in these transmission tags are:

- `<joint name="">` the name must correspond to a joint else where in your URDF
- `<type>` the type of transmission. Currently only `transmission_interface/SimpleTransmission` is implemented.
Expand All @@ -82,11 +84,12 @@ robot hardware interfaces between `ros2_control` and Gazebo.
```xml
<gazebo>
<plugin filename="libgazebo_ros2_control.so" name="gazebo_ros2_control">
<robot_sim_type>gazebo_ros2_control/DefaultRobotHWSim</robot_sim_type>
<robot_sim_type>gazebo_ros2_control/GazeboSystem</robot_sim_type>
<robot_param>robot_description</robot_param>
<robot_param_node>robot_state_publisher</robot_param_node>
<parameters>$(find gazebo_ros2_control_demos)/config/cartpole_controller.yaml</parameters>
<e_stop_topic>False</e_stop_topic>
<control_period>0.01</control_period>
</plugin>
</gazebo>
```
Expand All @@ -96,8 +99,9 @@ The `gazebo_ros2_control` `<plugin>` tag also has the following optional child e
- `<control_period>`: The period of the controller update (in seconds), defaults to Gazebo's period
- `<robot_param>`: The location of the `robot_description` (URDF) on the parameter server, defaults to `robot_description`
- `<robot_param_node>`: Name of the node where the `robot_param` is located, defauls to `robot_state_publisher`
- `<robot_sim_type>`: The pluginlib name of a custom robot sim interface to be used, defaults to `gazebo_ros2_control/DefaultRobotHWSim`
- `<robot_sim_type>`: The pluginlib name of a custom robot sim interface to be used, defaults to `gazebo_ros2_control/GazeboSystem`
- `<parameters>`: YAML file with the configuration of the controllers
- `<e_stop_topic>`: Topic to publish the emergency stop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a gazebo requirement? Is this a ros2_control requirement? We were planning to introduce some sort of e-stop handling but nothing is really designed for it yet. Is this to fulfill that use-case or a different one? I'd like to avoid having to remove functionality from the plugin/declare obsolete when we didn't really need to add it yet.


#### Default gazebo_ros2_control Behavior

Expand All @@ -113,14 +117,17 @@ The default behavior provides the following ros2_control interfaces:

The `gazebo_ros2_control` Gazebo plugin also provides a pluginlib-based interface to implement custom interfaces between Gazebo and `ros2_control` for simulating more complex mechanisms (nonlinear springs, linkages, etc).

These plugins must inherit `gazebo_ros2_control::RobotHWSim` which implements a simulated `ros2_control` `hardware_interface::RobotHW`. RobotHWSim provides API-level access to read and command joint properties in the Gazebo simulator.
These plugins must inherit `gazebo_ros2_control::GazeboSystemInterface` which implements a simulated `ros2_control`
`hardware_interface::SystemInterface`. SystemInterface provides API-level access to read and command joint properties.

The respective RobotHWSim sub-class is specified in a URDF model and is loaded when the robot model is loaded. For example, the following XML will load the default plugin (same behavior as when using no `<robot_sim_type>` tag):
The respective GazeboSystemInterface sub-class is specified in a URDF model and is loaded when the
robot model is loaded. For example, the following XML will load the default plugin
(same behavior as when using no `<robot_sim_type>` tag):

```xml
<gazebo>
<plugin name="gazebo_ros2_control" filename="libgazebo_ros2_control.so">
<robot_sim_type>gazebo_ros2_control/DefaultRobotHWSim</robot_sim_type>
<robot_sim_type>gazebo_ros2_control/GazeboSystem</robot_sim_type>
</plugin>
</gazebo>
```
Expand All @@ -138,13 +145,13 @@ Use the tag `<parameters>` inside `<plugin>` to set the YAML file with the contr
```

This controller publishes the state of all resources registered to a
`hardware_interface::JointStateInterface` to a topic of type `sensor_msgs/msg/JointState`. The following is a basic configuration of the controller.
`hardware_interface::StateInterface` to a topic of type `sensor_msgs/msg/JointState`.
The following is a basic configuration of the controller.

```yaml
joint_state_controller:
ros__parameters:
type: joint_state_controller/JointStateController
publish_rate: 50
```

This controller creates an action called `/cart_pole_controller/follow_joint_trajectory` of type `control_msgs::action::FollowJointTrajectory`.
Expand All @@ -166,7 +173,9 @@ cart_pole_controller:

#### Setting PID gains

To set the PID gains for a specific joint you need to define them inside `<plugin><ros></plugin></ros>`. Using the generic way of defining parameters with `gazebo_ros`. The name of the parameter correspond the name of the joint followed by a dot and the name of the parameter: `p`, `i`, `d`, `i_clamp_max`, `i_clamp_min` and `antiwindup`.
To set the PID gains for a specific joint you need to define them inside `<plugin><ros></plugin></ros>`.
ahcorde marked this conversation as resolved.
Show resolved Hide resolved
Using the generic way of defining parameters with `gazebo_ros`. The name of the parameter correspond to
the name of the joint followed by a dot and the name of the parameter: `p`, `i`, `d`, `i_clamp_max`, `i_clamp_min` and `antiwindup`.

```xml
<gazebo>
Expand All @@ -181,7 +190,7 @@ To set the PID gains for a specific joint you need to define them inside `<plugi
<parameter name="slider_to_cart.antiwindup" type="bool">false</parameter>
<remapping>e_stop_topic:=emergency_stop</remapping>
</ros>
<robot_sim_type>gazebo_ros2_control/DefaultRobotHWSim</robot_sim_type>
<robot_sim_type>gazebo_ros2_control/GazeboSystem</robot_sim_type>
<parameters>$(find gazebo_ros2_control_demos)/config/cartpole_controller.yaml</parameters>
...
</plugins>
Expand Down Expand Up @@ -228,11 +237,3 @@ ros2 param set /gazebo_ros2_control slider_to_cart.d 15.0
ros2 param set /gazebo_ros2_control slider_to_cart.i_clamp_max 3.0
ros2 param set /gazebo_ros2_control slider_to_cart.i_clamp_min -3.0
```

# NOTES

`ros2_control` and `ros2_controllers` are in a redesign phase. Some of the packages are unofficial.
In the following links you can track some of the missing features.

- https://github.com/ros-controls/ros2_control/issues/26
- https://github.com/ros-controls/ros2_control/issues/32
30 changes: 18 additions & 12 deletions gazebo_ros2_control/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ find_package(controller_manager REQUIRED)
find_package(gazebo_dev REQUIRED)
find_package(gazebo_ros REQUIRED)
find_package(hardware_interface REQUIRED)
find_package(joint_limits_interface REQUIRED)
find_package(pluginlib REQUIRED)
find_package(rclcpp REQUIRED)
find_package(transmission_interface REQUIRED)
Expand All @@ -23,7 +22,9 @@ endif()
include_directories(include)

# Libraries
add_library(${PROJECT_NAME} SHARED src/gazebo_ros2_control_plugin.cpp)
add_library(${PROJECT_NAME} SHARED
src/gazebo_ros2_control_plugin.cpp
)
ament_target_dependencies(${PROJECT_NAME}
controller_manager
gazebo_dev
Expand All @@ -36,27 +37,32 @@ ament_target_dependencies(${PROJECT_NAME}
yaml_cpp_vendor
)

add_library(default_robot_hw_sim SHARED src/default_robot_hw_sim.cpp)
ament_target_dependencies(default_robot_hw_sim
angles
control_toolbox
gazebo_dev
add_library(gazebo_hardware_plugins SHARED
src/gazebo_system.cpp
)
ament_target_dependencies(gazebo_hardware_plugins
ahcorde marked this conversation as resolved.
Show resolved Hide resolved
hardware_interface
joint_limits_interface
rclcpp
gazebo_dev
transmission_interface
control_toolbox
angles
)

## Install
install(TARGETS default_robot_hw_sim ${PROJECT_NAME}
install(TARGETS
${PROJECT_NAME}
gazebo_hardware_plugins
ARCHIVE DESTINATION lib
LIBRARY DESTINATION lib
RUNTIME DESTINATION bin
)

ament_export_dependencies(ament_cmake)
ament_export_dependencies(rclcpp)
ament_export_libraries(${PROJECT_NAME} default_robot_hw_sim)
ament_export_libraries(
${PROJECT_NAME}
gazebo_hardware_plugins
)

if(BUILD_TESTING)
find_package(ament_cmake_gtest REQUIRED)
Expand All @@ -68,6 +74,6 @@ install(DIRECTORY include/${PROJECT_NAME}/
DESTINATION include/${PROJECT_NAME}
)

pluginlib_export_plugin_description_file(gazebo_ros2_control robot_hw_sim_plugins.xml)
pluginlib_export_plugin_description_file(gazebo_ros2_control gazebo_hardware_plugins.xml)

ament_package()
10 changes: 10 additions & 0 deletions gazebo_ros2_control/gazebo_hardware_plugins.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<library path="gazebo_hardware_plugins">
<class
name="gazebo_ros2_control/GazeboSystem"
type="gazebo_ros2_control::GazeboSystem"
base_class_type="gazebo_ros2_control::GazeboSystemInterface">
<description>
GazeboPositionJoint
</description>
</class>
</library>

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,16 @@
#include <string>
#include <vector>

// ROS
#include "pluginlib/class_loader.hpp"
#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/bool.hpp"
#include "controller_manager/controller_manager.hpp"

// Gazebo
#include "gazebo/common/common.hh"
#include "gazebo/physics/physics.hh"
#include "gazebo/physics/Model.hh"

#include "pluginlib/class_loader.hpp"

#include "rclcpp/rclcpp.hpp"
#include "rclcpp_lifecycle/lifecycle_node.hpp"
ahcorde marked this conversation as resolved.
Show resolved Hide resolved

// ros_control
#include "controller_manager/controller_manager.hpp"
#include "gazebo_ros2_control/robot_hw_sim.hpp"
#include "transmission_interface/transmission_parser.hpp"

namespace gazebo_ros2_control
Expand Down
Loading