Skip to content

Commit 13a4bcd

Browse files
authored
Update README.md
1 parent d97ff9a commit 13a4bcd

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ The extensibility of the `EventsExecutor` comes from the fact that this core com
1818
For example in this repository we also include an extension that uses a lock-free queue, based on this great [concurrent queue](https://github.com/cameron314/concurrentqueue) implementation.
1919
Other extensions would allow to bound the queue or enforce deterministic execution constraints.
2020

21+
## Known bugs and limitations
22+
23+
The iRobot team is actively working to address these items.
24+
25+
- The executor is not notified when a ROS 2 timer is reset.
26+
- Enabling Intra-Process Optimization in rclcpp can result in [a runtime exception](https://github.com/ros2/rclcpp/blob/rolling/rclcpp/include/rclcpp/experimental/buffers/ring_buffer_implementation.hpp#L90).
27+
- The executor is broken with Fast-DDS in Humble. The following PR fixes the problem: https://github.com/ros2/rmw_fastrtps/pull/619
28+
2129
## Instructions
2230

2331
This repository provides libraries that can be built/installed alongside a standard ROS 2 installation and give access to the `EventsExecutor` class and its related components.
@@ -35,17 +43,21 @@ To build and run the examples you can do the following:
3543

3644
```
3745
docker run -it osrf/ros:humble-desktop bash
38-
sudo apt-get update && sudo apt-get upgrade && sudo apt-get install ros-humble-test-msgs
46+
sudo apt-get update && sudo apt-get upgrade && sudo apt-get install ros-humble-test-msgs ros-humble-rmw-cyclonedds-cpp
3947
mkdir -p /root/ws/src
4048
cd /root/ws/src
4149
git clone https://github.com/irobot-ros/events-executor.git
4250
cd ..
4351
colcon build
4452
source install/setup.sh
53+
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
4554
ros2 run events_executor_examples hello_events_executor
4655
```
4756

48-
## rclcpp PRs
57+
Note how we change the `RMW_IMPLEMENTATION` to CycloneDDS.
58+
In order to use Fast-DDS it's necessary to cherry-pick [this PR](https://github.com/ros2/rmw_fastrtps/pull/619) and re-build the `rmw_fastrtps` package.
59+
60+
## Events Executor PRs
4961

5062
List of Pull Requests that are introducing the `EventsExecutor` in the ROS 2 core repositories.
5163

@@ -63,7 +75,3 @@ List of Pull Requests that are introducing the `EventsExecutor` in the ROS 2 cor
6375

6476
- https://github.com/ros2/design/pull/305
6577
- https://github.com/ros2/rclcpp/pull/1891
66-
67-
## Known bugs and limitations
68-
69-
- The `EventsExecutor` is not notified when a ROS 2 timer is reset.

0 commit comments

Comments
 (0)