About this Install Guide

This guide is intended to get you up and running with this tool quickly with the most common settings. For a thorough review of all options, refer to the official documentation.

The Eclipse Cyclone DDS is an open-source implementation of the Data Distribution Service ( DDS ) standard, designed for high-performance, real-time, and scalable communication in autonomous systems, robotics, industrial IoT, and aerospace applications.

It is part of the Eclipse Foundation and is widely used in Robotic Operating System (ROS) 2 as a key middleware framework for inter-process communication.

Before you begin

This article provides a quick solution to install Cyclone DDS on Arm Linux.

Confirm you are using an Arm Linux machine by running:

    

        
        
uname -m

    

The output should be:

    

        
        aarch64

        
    

If you see a different result, you are not using an Arm computer running 64-bit Linux.

You need to install the following before building Cyclone DDS:

For Ubuntu Linux, run the commands below. For other Linux distributions, use the package manager to install the software listed above.

    

        
        
sudo apt update
sudo apt install -y gcc g++ git cmake libssl-dev

    

How do I build Cyclone DDS?

You can install Cyclone DDS by building the source code.

Clone the GitHub repository to create a build folder:

    

        
        
cd $HOME
git clone https://github.com/eclipse-cyclonedds/cyclonedds.git

    

Once downloaded, you can build and install Cyclone DDS.

Enable the flags BUILD_EXAMPLES (to compile the example applications included) and BUILD_TESTING (to compile the test suite).

Here are the build and install commands:

    

        
        
cd cyclonedds
mkdir build && cd build
cmake -DBUILD_EXAMPLES=ON -DBUILD_TESTING=ON ..
cmake --build .
sudo cmake --build . --target install

    

Cyclone DDS is now installed in /usr/local.

Note

If you don’t want to install Cyclone DDS in the default location of /usr/local, you can specify another location by adding -DCMAKE_INSTALL_PREFIX=<install-prefix> to the first cmake command with your alternative location.

How can I test Cyclone DDS?

To verify the installation, you can run the Hello World example from the build directory.

Open two terminals and navigate to the bin/ directory in each.

Run the commands shown below in each tab in each of your two terminals:

    

        
        

    cd $HOME/cyclonedds/build/bin/
    ./HelloworldPublisher
  

    
    

        
        

    cd $HOME/cyclonedds/build/bin/
    ./HelloworldSubscriber
  

    

If you observe the following output from each of the terminals, Cyclone DDS is running correctly on your Arm Linux machine.

    

        
        

    === [Publisher]  Waiting for a reader to be discovered ...
    === [Publisher]  Writing : Message (1, Hello World)
  

    
    

        
        

    === [Subscriber] Waiting for a sample ...
    === [Subscriber] Received : Message (1, Hello World)
  

    

You are now ready to use Cyclone DDS.


Give Feedback

How would you rate this tool quick-install guide?