Skip to content

Commit

Permalink
Update CI and docs (ros2#76)
Browse files Browse the repository at this point in the history
Signed-off-by: Simon Hoinkis <[email protected]>
  • Loading branch information
mossmaurice committed Jan 5, 2023
1 parent 339ef04 commit f0842b4
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 30 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/custom_repos.repos

This file was deleted.

9 changes: 4 additions & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Integration build rmw_iceoryx
on:
push:
branches:
- master
- humble
pull_request:

jobs:
Expand All @@ -17,13 +17,12 @@ jobs:
- uses: actions/checkout@v2
- name: Setup ROS
uses: ros-tooling/setup-ros@master
with:
required-ros-distributions: humble
- name: Install Iceoryx Dependencies
run: sudo apt-get update && sudo apt-get install -y cmake libacl1-dev libncurses5-dev pkg-config
- name: Build & Test
uses: ros-tooling/action-ros-ci@master
with:
package-name: rmw_iceoryx_cpp
target-ros2-distro: rolling
vcs-repo-file-url: |
https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos
${{ github.workspace }}/.github/workflows/custom_repos.repos
target-ros2-distro: humble
27 changes: 7 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,21 @@ Installation
The following instructions show you how to install the iceoryx rmw implementation.
The installation of rmw_iceoryx is pretty straight forward as [iceoryx](https://github.com/eclipse/iceoryx) is available in [ros2.repos](https://github.com/ros2/ros2/blob/master/ros2.repos).
All provided packages can be built with colcon so that you can easily build rmw_iceoryx within your ROS 2 workspace.
rmw_iceoryx is using the [rosidl_typesupport_introspection](https://github.com/ros2/rosidl) which allows for building iceoryx on top of an existing ROS2 workspace or even debian installation as no ROS 2 messages have to be built again.
rmw_iceoryx is using the [rosidl_typesupport_introspection](https://github.com/ros2/rosidl) which allows for building iceoryx on top of an existing ROS 2 workspace or even debian installation as no ROS 2 messages have to be built again.

To install rmw_iceoryx in a ROS 2 workspace with the latest ROS version, just execute the steps below:

```bash
mkdir -p ~/iceoryx_ws/src
cd $_
# LATEST_ROS_VERSION could be e.g. galactic
# LATEST_ROS_VERSION could be e.g. humble
git clone --branch LATEST_ROS_VERSION https://github.com/ros2/rmw_iceoryx.git
```

For alternative installation instructions and more details about iceoryx's internals, please see [iceoryx's GitHub repo](https://github.com/eclipse/iceoryx).

rmw_iceoryx is compatible with ROS 2 starting with Eloquent release.

If you want to use ROS 2 rolling, you need to checkout the `master` branch of both rmw_iceoryx and iceoryx:

```bash
cd ~/iceoryx_ws/
wget https://raw.githubusercontent.com/ros2/ros2/master/ros2.repos
# Change the line of Eclipse iceoryx to "version: master"
vcs import src < ros2.repos

cd ~/iceoryx_ws/src
git clone --branch master https://github.com/ros2/rmw_iceoryx.git
```

Assuming you have ROS2 installed correctly, you can compile the iceoryx workspace with colcon:
Assuming you have ROS 2 installed correctly, you can compile the iceoryx workspace with colcon:

```bash
cd ~/iceoryx_ws/
Expand All @@ -45,7 +32,7 @@ colcon build
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF
```

That's it! You've installed rmw_iceoryx and are ready to rumble.
That's it! You've installed iceoryx and are ready to rumble.

Working with rmw_iceoryx_cpp
============================
Expand All @@ -65,7 +52,7 @@ Before starting any iceoryx application, we therefore have to start the daemon.
You can then use rmw_iceoryx_cpp just like any other available rmw implementation.
In order to specify the rmw implementation, you have to set the environment variable `RMW_IMPLEMENTATION` to `rmw_iceoryx_cpp`.

To run the ROS2 c++ demo nodes with iceoryx, you can thus execute the following command:
To run the ROS 2 c++ demo nodes with iceoryx, you can thus execute the following command:

```bash
source ~/iceoryx_ws/install/setup.bash
Expand Down Expand Up @@ -152,8 +139,8 @@ Unfortunately, not all features are yet fully fleshed out.
| `ros2 node list` | :heavy_check_mark: |
| `ros2 node info` | :heavy_check_mark: |
| `ros2 interface *` | :heavy_check_mark: |
| `ros2 service *` | :heavy_check_mark |
| `ros2 param list` | :heavy_check_mark |
| `ros2 service *` | :heavy_check_mark: |
| `ros2 param list` | :x: |
| `rqt_graph` | :heavy_check_mark: |
| `rqt_top` | :heavy_check_mark: |
| `rqt_console` | :heavy_check_mark: |
Expand Down

0 comments on commit f0842b4

Please sign in to comment.