Skip to content

Commit 526f224

Browse files
Update yarp-devices-ros2 installation documentation (#34)
2 parents 0fdee7e + 1913e54 commit 526f224

File tree

1 file changed

+5
-22
lines changed

1 file changed

+5
-22
lines changed

README.md

+5-22
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ xcub-moveit2
1313

1414
## Overview
1515

16-
This repository contains the current state of the ROS2 packages for using iCub and ergoCub with MoveIt.
16+
This repository contains the current state of the ROS 2 packages for using iCub and ergoCub with MoveIt.
1717

1818
## Assumptions
1919

@@ -23,30 +23,13 @@ These packages were generated and tested with `ros humble` distro on a `Ubuntu 2
2323

2424
First of all, install [ROS 2 Humble](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html) on your machine and configure your [ROS 2 environment](https://docs.ros.org/en/humble/Tutorials/Beginner-CLI-Tools/Configuring-ROS2-Environment.html#configuring-environment). Then, follow the [MoveIt 2 install guide](https://moveit.ros.org/install-moveit2/binary/) to build all the necessary dependencies.
2525

26-
Moreover, it is mandatory to install `yarp-devices-ros2` on your machine to use custom ROS messages and services defined in [yarp_control_msgs](https://github.com/robotology/yarp-devices-ros2/tree/master/ros2_interfaces_ws/src/yarp_control_msgs):
26+
Moreover, it is mandatory to install `yarp-devices-ros2` on your machine to use custom ROS messages and services defined in [yarp_control_msgs](https://github.com/robotology/yarp-devices-ros2/tree/master/ros2_interfaces_ws/src/yarp_control_msgs). To do this, you can follow the [installation procedure](https://github.com/robotology/yarp-devices-ros2?tab=readme-ov-file#installation) described in the repository. Otherwise, starting from the distro [`v2024.11.0`](../sw_versioning_table/2024.11.0.md), it can be compiled within the robotology-superbuild by enabling the `ROBOTOLOGY_USES_ROS2` CMake option .
2727

28-
```shell
29-
# Clone the repository in your workspace
30-
git clone https://github.com/robotology/yarp-devices-ros2
31-
32-
# Build ROS msgs and compile the colcon workspace
33-
cd yarp-devices-ros2/ros2_interfaces_ws
34-
colcon build
35-
source install/setup.bash
36-
37-
# Compile yarp-devices-ros2 specifying the installation path
38-
cd ..
39-
mkdir build && cd build
40-
cmake .. -DCMAKE_INSTALL_PREFIX=<install_prefix>
41-
make
42-
make install
43-
```
44-
45-
This repository contains some devices and custom ROS2 interfaces with different purposes and, in particular for this application, it contains the possibility to control a `yarp-based` robot with ROS2. To enable this features, you have to add the `msgs_name` parameter in your configuration file that inizializes the device `controlBoard_nws_ros2`, for example:
28+
This repository contains some devices and custom ROS 2 interfaces with different purposes and, in particular for this application, it contains the possibility to control a `yarp-based` robot with ROS 2. To enable this features, you have to add the `msgs_name` parameter in your configuration file that inizializes the device `controlBoard_nws_ros2`, for example:
4629

4730
![msgs](assets/msgs_parameter.jpg)
4831

49-
Finally, [TRAC-IK](https://traclabs.com/projects/trac-ik/) is chosen as inverse kinematics solver. It is more accurate and faster when dealing with complex kinematic chains with respect to KDL Kinematics, which represents the standard for MoveIt 2. To install it inside your ROS2 workspace:
32+
Finally, [TRAC-IK](https://traclabs.com/projects/trac-ik/) is chosen as inverse kinematics solver. It is more accurate and faster when dealing with complex kinematic chains with respect to KDL Kinematics, which represents the standard for MoveIt 2. To install it inside your ROS 2 workspace:
5033

5134
```shell
5235
cd ~/<ros2_ws>/src
@@ -70,7 +53,7 @@ To install the project from source, please follow **only one** of the following
7053
7154
### Install with colcon
7255
73-
In your ROS2 workspace, clone the repo:
56+
In your ROS 2 workspace, clone the repo:
7457
7558
```shell
7659
cd ~/<ros2_ws>/src

0 commit comments

Comments
 (0)