niklas/rmw_cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
56 commits 1 branch 0 tags 679 KiB
Find a file
Dan Rose 3edf332573 Use rosdep (#32) 
* Add Cyclone DDS build dependencies for rosdep

* Update README.md

Change apt install commands to rosdep install.

* build_depend -> buildtool_depend for maven and java

* Add vendor package to build cyclonedds from source

Remove maven and java dependency (thanks, @eboasson)

* remove --symlink-build flag

this obscures the intention of the code and sophisticated users can choose whether to use it or not.

* add rosdep to readme
2019-09-13 11:54:06 +02:00
.github initial commit 2018-07-09 13:22:25 +02:00
cyclonedds_cmake_module Use rosdep (#32) 2019-09-13 11:54:06 +02:00
cyclonedds_vendor Use rosdep (#32) 2019-09-13 11:54:06 +02:00
rmw_cyclonedds_cpp Use rosdep (#32) 2019-09-13 11:54:06 +02:00
CONTRIBUTING.md initial commit 2018-07-09 13:22:25 +02:00
LICENSE initial commit 2018-07-09 13:22:25 +02:00
README.md Use rosdep (#32) 2019-09-13 11:54:06 +02:00

README.md

A ROS2 RMW implementation for Eclipse Cyclone DDS

With the code in this repository, it is possible to use ROS2 with Eclipse Cyclone DDS as the underlying DDS implementation.

Getting, building and using it

All it takes to get Cyclone DDS support into ROS2 is to clone this repository into the ROS2 workspace source directory, and then run colcon build in the usual manner:

cd ros2_ws/src
git clone https://github.com/atolab/rmw_cyclonedds
cd ..
rosdep install --from src -i
colcon build --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCYCLONEDDS_FROM_SOURCE=ON
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp

If you prefer to install CycloneDDS yourself, set -DCYCLONEDDS_FROM_SOURCE=OFF. CMake caches this value, so you can omit it between builds

This seems to work fine on Linux with a binary ROS2 installation as well as when building ROS2 from source. On macOS it has only been tested in a source build on a machine in an "unsupported" configuration (macOS 10.14 with SIP enabled, instead of 10.12 with SIP disabled), and apart from a few details that are caused by the machine configuration, that works fine, too. There is no reason why it wouldn't work the same on Windows, but I haven't tried.

If you want to use a pre-existing installation of Cyclone DDS, you don't need to clone it, but you may have to tell CMake where to look for it using the CycloneDDS_DIR variable. That also appears to be the case if there are other packages in the ROS2 workspace that you would like to use Cyclone DDS directly instead of via the ROS2 abstraction.

Known limitations

There are a number of known limitations:

  • Cyclone DDS does not yet implement DDS Security. Consequently, there is no support for security in this RMW implementation either.

  • Deserialization only handles native format (it doesn't do any byte swapping). This is pure laziness, adding it is trivial.

  • Deserialization assumes the input is valid and will do terrible things if it isn't. Again, pure laziness, it's just adding some bounds checks and other validation code.