Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | humble |
Last Updated | 2022-11-07 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 1.3.4 |
README
ROS 2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS middleware for ROS 2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS 2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS 2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS 2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS 2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
Quality Declaration
This package claims to be in the Quality Level 2 category, see the Quality Declaration for more details.
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | iron |
Last Updated | 2023-04-12 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 1.6.0 |
README
ROS 2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS Tier 1 ROS middleware for ROS 2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS 2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS 2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS 2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS 2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
Quality Declaration
This package claims to be in the Quality Level 2 category, see the Quality Declaration for more details.
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | jazzy |
Last Updated | 2024-11-28 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 2.2.2 |
README
ROS 2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS Tier 1 ROS middleware for ROS 2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS 2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS 2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS 2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS 2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
Quality Declaration
This package claims to be in the Quality Level 2 category, see the Quality Declaration for more details.
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | rolling |
Last Updated | 2024-11-28 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 3.1.0 |
README
ROS 2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS Tier 1 ROS middleware for ROS 2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS 2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS 2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS 2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS 2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
Quality Declaration
This package claims to be in the Quality Level 2 category, see the Quality Declaration for more details.
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | dashing-eloquent |
Last Updated | 2020-09-15 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
cyclonedds_cmake_module | 0.7.0 |
rmw_cyclonedds_cpp | 0.7.0 |
README
ROS2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS middleware for ROS2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
2) Set env variable and run ROS2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3) Confirm RMW: In Eloquent, to confirm which RMW you're using:
```ros2 doctor --report
Building from source and contributing
Note the master
branch maintains compatibility with ROS releases Dashing and later, including the not-yet-released Foxy.
If building ROS2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | dashing-eloquent |
Last Updated | 2020-09-15 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
cyclonedds_cmake_module | 0.7.0 |
rmw_cyclonedds_cpp | 0.7.0 |
README
ROS2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS middleware for ROS2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
2) Set env variable and run ROS2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3) Confirm RMW: In Eloquent, to confirm which RMW you're using:
```ros2 doctor --report
Building from source and contributing
Note the master
branch maintains compatibility with ROS releases Dashing and later, including the not-yet-released Foxy.
If building ROS2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | galactic |
Last Updated | 2022-12-03 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 0.22.6 |
README
ROS 2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS middleware for ROS 2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS 2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS 2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS 2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy. -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS 2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Repository Summary
Checkout URI | https://github.com/ros2/rmw_cyclonedds.git |
VCS Type | git |
VCS Version | foxy |
Last Updated | 2022-09-20 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
rmw_cyclonedds_cpp | 0.7.11 |
README
ROS2 RMW for Eclipse Cyclone DDS
Easy, fast, reliable, small Eclipse Cyclone DDS middleware for ROS2. Make your đ˘ run like a đ Eclipse Cyclone DDS has great adopters and contributors in the ROS community and is an Eclipse Foundation open source project of Eclipse IoT and OpenADx (autonomous driving).
This package lets ROS2 use Eclipse Cyclone DDS as the underlying DDS implementation. Cyclone DDS is ready to use. It seeks to give the fastest, easiest, and most robust ROS2 experience. Let the Cyclone blow you away!
- Install:
apt install ros-eloquent-rmw-cyclonedds-cpp
or
apt install ros-dashing-rmw-cyclonedds-cpp
- Set env variable and run ROS2 apps as usual:
```export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
3. Confirm RMW: In Eloquent and later, to confirm which RMW you're using:
```ros2 doctor --report
Performance recommendations
With large samples (100s of kilobytes), excessive latency can be caused by running out of space in the OS-level receive buffer. For this reason, on Linux, we recommend increasing the buffer size:
- Temporarily (until reboot):
sudo sysctl -w net.core.rmem_max=8388608 net.core.rmem_default=8388608
- Permanently:
echo "net.core.rmem_max=8388608\nnet.core.rmem_default=8388608\n" | sudo tee /etc/sysctl.d/60-cyclonedds.conf
Debugging
So Cyclone isnât playing nice or not giving you the performance you had hoped for? Thatâs not good⌠Please file an issue against this repository!
The ddsperf
tool distributed with Cyclone DDS can be used to check that communication works without ROS. Run ddsperf sanity
on two different machines - if the âmeanâ value is above 100000us
, there are likely network issues.
If youâre having trouble with nodes discovering others or canât use multicast at all on your network setup, you can circumvent discovery:
export CYCLONEDDS_URI='<Discovery><Peers><Peer Address='myroshost.local' /><Peer Address='myroshost2.local' /></></>'
Here are some ways to generate additional debugging info that can help identify the problem faster, and are helpful on an issue ticket:
-
Configure Cyclone to create richer debugging output:
-
To see the output live:
export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>stderr</></>'
-
To send to
/var/log/
:export CYCLONEDDS_URI='<Tracing><Verbosity>trace</><Out>/var/log/cyclonedds.${CYCLONEDDS_PID}.log</></>'
-
-
Create a Wireshark capture:
wireshark -k -w wireshark.pcap.gz
Building from source and contributing
The following branches are actively maintained:
-
master
, which targets the upcoming ROS version, Foxy. -
dashing-eloquent
, which maintains compatibility with ROS releases Dashing and Eloquent
If building ROS2 from source (ros2.repos), you already have this package and Cyclone DDS:
cd /opt/ros/master
rosdep install --from src -i
colcon build
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
CONTRIBUTING
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that license:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.