Repository Summary

Checkout URI https://github.com/eProsima/Fast-DDS.git
VCS Type git
VCS Version 2.6.x
Last Updated 2022-05-13
Dev Status MAINTAINED
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
fastrtps 2.6.0

README

eProsima Fast DDS

FIWARE Robotics License Releases Issues Forks Stars Twitter Follow
Documentation badge Status Linux ci Linux arm64 ci Windows ci Mac ci Coverage

eprosima Fast DDS (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution Service (DDS) standard. eProsima Fast DDS expose an API to access directly the RTPS protocol, giving the user full access to the protocol internals.

Some of the main features of this library are:

  • Configurable best-effort and reliable publish-subscribe communication policies for real-time applications.
  • Plug and play connectivity so that any new applications are automatically discovered by any other members of the network.
  • Modularity and scalability to allow continuous growth with complex and simple devices in the network.
  • Configurable network behavior and interchangeable transport layer: Choose the best protocol and system input/output channel combination for each deployment.
  • Two API Layers: a high-level Publisher-Subscriber one focused on usability (DDS) and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

eProsima Fast DDS has been adopted by multiple organizations in many sectors including these important cases:

  • Robotics: ROS (Robotic Operating System) as their default middleware for every ROS 2 long term (LTS) releases and most of the non-LTS releases.
  • EU R&D: FIWARE Incubated GE.

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for Robotics.

Want us to share your project with the community?

Write to evaluation.support@eprosima.com or mention @EProsima on Twitter. We are curious to get to know your use case!

Supported platforms

More information about the official support can be found here

  • Linux Linux ci
  • Linux-aarch64 Linux arm64 ci
  • Windows Windows ci
  • Mac Mac ci

Installation Guide

You can get either a binary distribution of eprosima Fast DDS or compile the library yourself from source. Please, refer to Fast DDS documentation for the complete installation guide.

Installation from binaries

The latest, up to date binary release of eprosima Fast DDS can be obtained from the company website.

Documentation

You can access the documentation online, which is hosted on Read the Docs.

Quality Declaration

eprosima Fast DDS claims to be in the Quality Level 1 category based on the guidelines provided by ROS 2. See the Quality Declaration for more details.

Quick Demo

eProsima provides the eProsima Fast DDS Suite Docker image for those who want a quick demonstration of Fast-DDS running on an Ubuntu platform. It can be downloaded from eProsima's downloads page.

This Docker image was built for Ubuntu 20.04 (Focal Fossa).

To run this container you need Docker installed. From a terminal run the following command

$ sudo apt-get install docker.io

Load the docker image:

$ docker load -i ubuntu-fastdds-suite:<FastDDS-Version>.tar
$ docker tag ubuntu-fastdds-suite:<FastDDS-Version> ubuntu-fastdds-suite:latest

Run the eProsima Fast DDS Suite Docker container:

$ xhost local:root
$ docker run -it --privileged -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \
ubuntu-fastdds-suite:<FastDDS-Version>

This Docker Image comes bundled with the following:

Shapes Demo

eProsima Shapes Demo is an application in which Publishers and Subscribers are shapes of different colors and sizes moving on a board. Each shape refers to its own topic: Square, Triangle or Circle. A single instance of the eProsima Shapes Demo can publish on or subscribe to several topics at a time.

You can read more about this application on the Shapes Demo documentation page.

To run this application once inside the Docker container run:

$ ShapesDemo

eProsima Shapes Demo usage information can be found on the Shapes Demo First Steps page.

Fast DDS Monitor

eProsima Fast DDS Monitor is a graphical desktop application aimed at monitoring DDS environments deployed using the eProsima Fast DDS library. Thus, the user can monitor in real time the status of publication/subscription communications between DDS entities. They can also choose from a wide variety of communication parameters to be measured (latency, throughput,packet loss, etc.), as well as record and compute in real time statistical measurements on these parameters (mean, variance, standard deviation, etc.).

You can read more about this application on the Fast DDS Monitor documentation page.

To run this application once inside the Docker container run:

$ fastdds_monitor

eProsima Fast DDS Monitor usage information can be found on the Fast DDS Monitor User Manual.

Fast DDS libraries and Examples

Included in this Docker container is a set of binary examples that showcase several functionalities of the Fast DDS libraries. These examples' path can be accessed from a terminal by typing

$ goToExamples

From this folder you can access all examples, both for DDS and RTPS. We detail the steps to launch two such examples below.

To launch the Hello World example (a minimal example that will perform a Publisher/Subscriber match and start sending samples) you could run:

$ goToExamples
$ cd HelloWorldExample/bin
$ tmux new-session "./HelloWorldExample publisher 0 1000" \; \
split-window "./HelloWorldExample subscriber" \; \
select-layout even-vertical

This example is not constrained to the current instance. It's possible to run several instances of this container to check the communication between them by running the following from each container.

$ goToExamples
$ cd HelloWorldExample/bin
$ ./HelloWorldExample publisher

or

$ goToExamples
$ cd HelloWorldExample/bin
$ ./HelloWorldExample subscriber

Another example you could launch is the Benchmark example. This example creates either a Publisher or a Subscriber and on a successful match starts sending samples. After a few seconds the process that launched the Publisher will show a report with the number of samples transmitted.

On the subscriber side, run:

$ goToExamples
$ cd Benchmark/bin
$ ./Benchmark subscriber udp

On the publisher side, run:

$ goToExamples
$ cd Benchmark/bin
$ ./Benchmark publisher udp

Getting Help

If you need support you can reach us by mail at support@eProsima.com or by phone at +34 91 804 34 48.


rosin_logo

Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components. More information: rosin-project.eu

eu_flag

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement no. 732287.

CONTRIBUTING

Contribution Guidelines

The following documents constitutes a set of guidelines to which contributors must adhere.

Contributions Licensing

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.

Developer Certificate of Origin

Contributors must sign-off each commit by adding a Signed-off-by: ... line to commit messages to certify that they have the right to submit the code they are contributing to the project according to the Developer Certificate of Origin (DCO).

Code Coverage

As stated in QUALITY.md, all contributions to the project must increase line code coverage. Because of this, contributors are asked to locally run a coverage assessment that ensures that code coverage has increased when compared to the latest execution of the nightly coverage CI job.

Issues and Support

eProsima Fast DDS developers welcome all contributions, and we will be grateful if you follow the guidelines below while contributing to this project. Firs of all, there are several products related with Fast DDS. Please, open the issue in the corresponding repository:

Also, this project classifies user issues in the following categories. Please, help us giving you a better support by opening your issue in the corresponding category.

Issues

Fast DDS issues are understood as bug reports and may be opened by anyone here. Consequently, this section handles malfunctions in the current documented behavior of the library or non-compliances to the DDS specification. If you are unsure on whether your experienced behavior falls into this category, please open a ticket in the Support discussion forum and, if it is a malfunction, an issue will be opened on your behalf with the provided report.

An issue template is provided and it is really appreciated if all related information is provided so the issue may be reproduced. Otherwise, more information could be required in order to reproduce and solve the issue. If this is the case, the issue will be labeled with need more info. Please, be advised that in case that no response is received within a month, the issue would be closed due to inactivity. The issue may be reopened if the required information is provided.

Feature request

Feature requests and improvements suggestions should be opened in the Ideas discussion forum. Please, remember to select the corresponging category while opening the discussion. It is also encouraged to contact directly with eProsima support team for a feature evaluation.

Q&A

Questions about eProsima Fast DDS behavior and features should be opened in the Q&A (Questions & Answers) discussion forum. Please, remember to select the correct category while opening the discussion. It is strongly advised to first consult eProsima Fast DDS documentation and previous Q&A in the forum.

Support

Most user issues would fall in this category. eProsima Fast DDS provides a lot of features and tuning the library for optimal behavior for each use case is not an easy task. These issues should be opened in the Support discussion forum. Please, remember to select the corresponding category while opening the discussion. Please, take into account that eProsima Fast DDS provides official support for the Tier 1 platforms, architectures and compilers defined here. Any other support should be opened in the next section: Unofficial support

Unofficial support

Any issue related with a non-officially supported platform, architecture and/or compiler should be opened in the Unofficial support discussion forum. Please, remember to select the corresponding category while opening the discussion. If official support is wanted for any platform, architecture and/or compiler, please contact directly with eProsima support team for an evaluation.


Repository Summary

Checkout URI https://github.com/eProsima/Fast-DDS.git
VCS Type git
VCS Version 2.3.x
Last Updated 2022-04-28
Dev Status MAINTAINED
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
fastrtps 2.3.4

README

eProsima Fast DDS

tweet button

FIWARE Robotics License Releases Issues Forks Stars
Documentation badge Status Linux ci Linux arm64 ci Windows ci Mac ci Coverage

eprosima Fast DDS (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution Service (DDS) standard. eProsima Fast DDS expose an API to access directly the RTPS protocol, giving the user full access to the protocol internals.

Some of the main features of this library are:

  • Configurable best-effort and reliable publish-subscribe communication policies for real-time applications.
  • Plug and play connectivity so that any new applications are automatically discovered by any other members of the network.
  • Modularity and scalability to allow continuous growth with complex and simple devices in the network.
  • Configurable network behavior and interchangeable transport layer: Choose the best protocol and system input/output channel combination for each deployment.
  • Two API Layers: a high-level Publisher-Subscriber one focused on usability (DDS) and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

eProsima Fast DDS has been adopted by multiple organizations in many sectors including these important cases:

  • Robotics: ROS (Robotic Operating System) as their default middleware for ROS2 until and including the latest long term release Foxy Fitzroy.
  • EU R&D: FIWARE Incubated GE.

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for Robotics.

Want us to share your project with the community?

Write to evaluation.support@eprosima.com or mention @EProsima on Twitter. We are curious to get to know your use case!

Supported platforms

  • Linux Linux ci
  • Linux-aarch64 Linux arm64 ci
  • Windows Windows ci
  • Mac Mac ci

Installation Guide

You can get either a binary distribution of eprosima Fast DDS or compile the library yourself from source.

Installation from binaries

The latest, up to date binary release of eprosima Fast DDS can be obtained from the company website.

Installation from Source

Dependencies

Asio and TinyXML2 libraries

On Linux, you can install these libraries using the package manager of your Linux distribution. For example, on Ubuntu you can install them by using its package manager with the next command.

sudo apt install libasio-dev libtinyxml2-dev

On Windows, you can install these libraries using Chocolatey. First, download the following chocolatey packages from this ROS2 Github repository.

  • asio.1.12.1.nupkg
  • tinyxml2.6.0.0.nupkg

Once these packages are downloaded, open an administrative shell and execute the following command:

choco install -y -s <PATH\TO\DOWNLOADS\> asio tinyxml2

Please replace <PATH\TO\DOWNLOADS> with the folder you downloaded the packages to.

Colcon installation

colcon is a command line tool to build sets of software packages. This section explains to use it to compile easily Fast-RTPS and its dependencies. First install ROS2 development tools (colcon and vcstool):

pip install -U colcon-common-extensions vcstool

Download the repos file that will be used to download Fast RTPS and its dependencies:

$ mkdir fastdds_ws
$ cd fastdds_ws
$ wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos
$ mkdir src
$ vcs import src < fastrtps.repos

Finally, use colcon to compile all software:

$ colcon build

Manual installation

Before compiling manually Fast DDS you need to clone the following dependencies and compile them using CMake.

    $ git clone https://github.com/eProsima/Fast-CDR.git
    $ mkdir Fast-CDR/build && cd Fast-CDR/build
    $ cmake ..
    $ cmake --build . --target install

    $ git clone https://github.com/eProsima/foonathan_memory_vendor.git
    $ cd foonathan_memory_vendor
    $ mkdir build && cd build
    $ cmake ..
    $ cmake --build . --target install

Once all dependencies are installed, you will be able to compile and install Fast DDS.

$ git clone https://github.com/eProsima/Fast-DDS.git
$ mkdir Fast-DDS/build && cd Fast-DDS/build
$ cmake ..
$ cmake --build . --target install

Documentation

You can access the documentation online, which is hosted on Read the Docs.

Quality Declaration

eprosima Fast DDS claims to be in the Quality Level 1 category based on the guidelines provided by ROS 2. See the Quality Declaration for more details.

Quick Demo

For those who want to try a quick demonstration of Fast DDS libraries on Ubuntu, here is a way to launch an example application.

First, download and install docker application. Open a terminal and type the following command:

$ sudo apt-get install docker.io

Then, download the docker image files from the eProsima downloads website.

Load the docker images:

$ docker load -i ubuntu-fast-dds:<FastDDS-Version>.tar
$ docker tag ubuntu-fast-rtps:<FastDDS-Version> ubuntu-fast-rtps:latest
$ docker load -i ubuntu-fast-dds-helloworld:<FastDDS-Version>.tar
$ docker load -i ubuntu-fast-dds-shapesdemo:<ShapesDemo-Version>.tar

Run the Docker container with the eProsima Shapes Demo application. Please refer to Shapes Demo documentation for further details on how to use this application.

$ xhost local:root
$ docker run -it --privileged -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \
    ubuntu-fast-dds-shapesdemo:<ShapesDemo-Version>

It is also possible to run the Fast DDS HelloWorld example by executing the following command:

$ docker run -it ubuntu-fast-dds-helloworld:<FastDDS-Version>

Run as many images as wanted and check the communication between them.

For instance, to run Benchmark example, run the following commands in the separate terminal sessions:

$ docker run -i ubuntu-fast-rtps /usr/local/examples/C++/Benchmark/bin/Benchmark subscriber udp
$ docker run -i ubuntu-fast-rtps /usr/local/examples/C++/Benchmark/bin/Benchmark publisher udp

Getting Help

If you need support you can reach us by mail at support@eProsima.com or by phone at +34 91 804 34 48.


rosin_logo

Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components. More information: rosin-project.eu

eu_flag

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement no. 732287.

CONTRIBUTING

Contribution Guidelines

The following documents constitutes a set of guidelines to which contributors must adhere.

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.

Developer Certificate of Origin

Contributors must sign-off each commit by adding a Signed-off-by: ... line to commit messages to certify that they have the right to submit the code they are contributing to the project according to the Developer Certificate of Origin (DCO).

Code Coverage

As stated in QUALITY.md, all contributions to the project must increase line code coverage. Because of this, contributors are asked to locally run a coverage assessment that ensures that code coverage has increased when compared to the latest execution of the nightly coverage CI job.


Repository Summary

Checkout URI https://github.com/eProsima/Fast-DDS.git
VCS Type git
VCS Version 2.1.x
Last Updated 2022-04-28
Dev Status MAINTAINED
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
fastrtps 2.1.1

README

eProsima Fast DDS

FIWARE Robotics License Releases Issues Forks Stars
Documentation badge Status Linux ci Linux arm64 ci Windows ci Mac ci Coverage

eprosima Fast DDS (formerly Fast RTPS) is a C++ implementation of the DDS (Data Distribution Service) standard of the OMG (Object Management Group). eProsima Fast DDS implements the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution Service (DDS) standard. eProsima Fast DDS expose an API to access directly the RTPS protocol, giving the user full access to the protocol internals.

Some of the main features of this library are:

  • Configurable best-effort and reliable publish-subscribe communication policies for real-time applications.
  • Plug and play connectivity so that any new applications are automatically discovered by any other members of the network.
  • Modularity and scalability to allow continuous growth with complex and simple devices in the network.
  • Configurable network behavior and interchangeable transport layer: Choose the best protocol and system input/output channel combination for each deployment.
  • Two API Layers: a high-level Publisher-Subscriber one focused on usability (DDS) and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

eProsima Fast DDS has been adopted by multiple organizations in many sectors including these important cases:

  • Robotics: ROS (Robotic Operating System) as their default middleware for ROS2.
  • EU R&D: FIWARE Incubated GE.

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for Robotics.


Want us to share your project with the community? Write to Evaluation.Support@eprosima.com or mention @EProsima on Twitter. We are curious to get to know your use case!


Supported platforms

  • Linux Linux ci
  • Linux-aarch64 Linux arm64 ci
  • Windows Windows ci
  • Mac Mac ci

Installation Guide

You can get either a binary distribution of eprosima Fast DDS or compile the library yourself from source.

Installation from binaries

The latest, up to date binary release of eprosima Fast DDS can be obtained from the company website.

Installation from Source

Dependencies

Asio and TinyXML2 libraries

On Linux, you can install these libraries using the package manager of your Linux distribution. For example, on Ubuntu you can install them by using its package manager with the next command.

sudo apt install libasio-dev libtinyxml2-dev

On Windows, you can install these libraries using Chocolatey. First, download the following chocolatey packages from this ROS2 Github repository.

  • asio.1.12.1.nupkg
  • tinyxml2.6.0.0.nupkg

Once these packages are downloaded, open an administrative shell and execute the following command:

choco install -y -s <PATH\TO\DOWNLOADS\> asio tinyxml2

Please replace <PATH\TO\DOWNLOADS> with the folder you downloaded the packages to.

Colcon installation


colcon is a command line tool to build sets of software packages. This section explains to use it to compile easily Fast-RTPS and its dependencies. First install ROS2 development tools (colcon and vcstool):

pip install -U colcon-common-extensions vcstool

Download the repos file that will be used to download Fast RTPS and its dependencies:

$ mkdir fastdds_ws
$ cd fastdds_ws
$ wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastrtps.repos
$ mkdir src
$ vcs import src < fastrtps.repos

Finally, use colcon to compile all software:

$ colcon build

Manual installation


Before compiling manually Fast DDS you need to clone the following dependencies and compile them using CMake.

    $ git clone https://github.com/eProsima/Fast-CDR.git
    $ mkdir Fast-CDR/build && cd Fast-CDR/build
    $ cmake ..
    $ cmake --build . --target install

    $ git clone https://github.com/eProsima/foonathan_memory_vendor.git
    $ cd foonathan_memory_vendor
    $ mkdir build && cd build
    $ cmake ..
    $ cmake --build . --target install

Once all dependencies are installed, you will be able to compile and install Fast DDS.

$ git clone https://github.com/eProsima/Fast-DDS.git
$ mkdir Fast-DDS/build && cd Fast-DDS/build
$ cmake ..
$ cmake --build . --target install

Documentation

You can access the documentation online, which is hosted on Read the Docs.

Quality Declaration

eprosima Fast DDS claims to be in the Quality Level 2 category based on the guidelines provided by ROS 2. See the Quality Declaration for more details.

Quick Demo

For those who want to try a quick demonstration of Fast-DDS libraries on Ubuntu, here is a way to launch an example application.

First, download and install docker application. Open a terminal and type the following command

$ sudo apt-get install docker.io

Then, download the docker image file from https://eprosima.com/index.php/downloads-all

Load the image and run it:

$ docker load -i ubuntu-fast-rtps.tar
$ docker run -it ubuntu-fast-rtps

You can run as many images as you want and check the communication between them.

Getting Help

If you need support you can reach us by mail at support@eProsima.com or by phone at +34 91 804 34 48.


rosin_logo

Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components. More information: rosin-project.eu

eu_flag

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement no. 732287.

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.

Contributors must sign-off each commit by adding a Signed-off-by: ... line to commit messages to certify that they have the right to submit the code they are contributing to the project according to the Developer Certificate of Origin (DCO).


Repository Summary

Checkout URI https://github.com/eProsima/Fast-DDS.git
VCS Type git
VCS Version master
Last Updated 2020-03-17
Dev Status MAINTAINED
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

No packages found.

README

eProsima Fast RTPS

Releases License Issues Forks Stars

eprosima Fast RTPS is a C++ implementation of the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution Service (DDS) standard, again by the OMG. eProsima Fast RTPS holds the benefit of being standalone and up-to-date, as most vendor solutions either implement RTPS as a tool to implement DDS or use past versions of the specification.

Some of the main features of this library are:

  • Configurable best-effort and reliable publish-subscribe communication policies for real-time applications.
  • Plug and play connectivity so that any new applications are automatically discovered by any other members of the network.
  • Modularity and scalability to allow continuous growth with complex and simple devices in the network.
  • Configurable network behavior and interchangeable transport layer: Choose the best protocol and system input/output channel combination for each deployment.
  • Two API Layers: a high-level Publisher-Subscriber one focused on usability and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

eProsima Fast RTPS has been adopted by multiple organizations in many sectors including these important cases:

  • Robotics: ROS (Robotic Operating System) as their default middleware for ROS2.
  • EU R&D: FIWARE Incubated GE.

Supported platforms

  • Linux Linux Build Status
  • Windows Windows Build Status
  • Mac Mac Build Status

Installation Guide

You can get either a binary distribution of eprosima Fast RTPS or compile the library yourself from source.

Installation from binaries

The latest, up to date binary release of eprosima Fast RTPS can be obtained from the company website.

Installation from Source

Dependencies

Asio and TinyXML2 libraries

On Linux, you can install these libraries using the package manager of your Linux distribution. For example, on Ubuntu you can install them by using its package manager with the next command.

sudo apt install libasio-dev libtinyxml2-dev

On Windows, you can install these libraries using Chocolatey. First, download the following chocolatey packages from this ROS2 Github repository.

  • asio.1.12.1.nupkg
  • tinyxml2.6.0.0.nupkg

Once these packages are downloaded, open an administrative shell and execute the following command:

choco install -y -s <PATH\TO\DOWNLOADS\> asio tinyxml2

Please replace <PATH\TO\DOWNLOADS> with the folder you downloaded the packages to.

Colcon installation


colcon is a command line tool to build sets of software packages. This section explains to use it to compile easily Fast-RTPS and its dependencies. First install ROS2 development tools (colcon and vcstool):

pip install -U colcon-common-extensions vcstool

Download the repos file that will be used to download Fast RTPS and its dependencies:

$ wget https://raw.githubusercontent.com/eProsima/Fast-RTPS/master/fastrtps.repos
$ mkdir src
$ vcs import src < fastrtps.repos

Finally, use colcon to compile all software:

$ colcon build

Manual installation


Before compiling manually Fast RTPS you need to clone the following dependencies and compile them using CMake.

    $ git clone https://github.com/eProsima/Fast-CDR.git
    $ mkdir Fast-CDR/build && cd Fast-CDR/build
    $ cmake ..
    $ cmake --build . --target install

    $ git clone https://github.com/eProsima/foonathan_memory_vendor.git
    $ cd foonathan_memory_vendor
    $ mkdir build && cd build
    $ cmake ..
    $ cmake --build . --target install

Once all dependencies are installed, you will be able to compile and install Fast RTPS.

$ git clone https://github.com/eProsima/Fast-RTPS.git
$ mkdir Fast-RTPS/build && cd Fast-RTPS/build
$ cmake ..
$ cmake --build . --target install

Documentation

You can access the documentation online, which is hosted on Read the Docs.

Quick Demo

For those who want to try a quick demonstration of Fast-RTPS libraries on Ubuntu, here is a way to launch an example application.

First, download and install docker application. Open a terminal and type the following command

$ sudo apt-get install docker.io

Then, download the docker image file from https://eprosima.com/index.php/downloads-all

Load the image and run it:

$ docker load -i ubuntu-fast-rtps.tar
$ docker run -it ubuntu-fast-rtps

You can run as many images as you want and check the communication between them.

Getting Help

If you need support you can reach us by mail at support@eProsima.com or by phone at +34 91 804 34 48.

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/eProsima/Fast-DDS.git
VCS Type git
VCS Version ros2-eloquent
Last Updated 2021-02-19
Dev Status MAINTAINED
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

No packages found.

README

eProsima Fast RTPS

Releases License Issues Forks Stars

eprosima Fast RTPS is a C++ implementation of the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution Service (DDS) standard, again by the OMG. eProsima Fast RTPS holds the benefit of being standalone and up-to-date, as most vendor solutions either implement RTPS as a tool to implement DDS or use past versions of the specification.

Some of the main features of this library are:

  • Configurable best-effort and reliable publish-subscribe communication policies for real-time applications.
  • Plug and play connectivity so that any new applications are automatically discovered by any other members of the network.
  • Modularity and scalability to allow continuous growth with complex and simple devices in the network.
  • Configurable network behavior and interchangeable transport layer: Choose the best protocol and system input/output channel combination for each deployment.
  • Two API Layers: a high-level Publisher-Subscriber one focused on usability and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol.

eProsima Fast RTPS has been adopted by multiple organizations in many sectors including these important cases:

  • Robotics: ROS (Robotic Operating System) as their default middleware for ROS2.
  • EU R&D: FIWARE Incubated GE.

Supported platforms

  • Linux Linux Build Status
  • Windows Windows Build Status
  • Mac Mac Build Status

Installation Guide

You can get either a binary distribution of eprosima Fast RTPS or compile the library yourself from source.

Installation from binaries

The latest, up to date binary release of eprosima Fast RTPS can be obtained from the company website.

Installation from Source

Dependencies

Asio and TinyXML2 libraries

On Linux, you can install these libraries using the package manager of your Linux distribution. For example, on Ubuntu you can install them by using its package manager with the next command.

sudo apt install libasio-dev libtinyxml2-dev

On Windows, you can install these libraries using Chocolatey. First, download the following chocolatey packages from this ROS2 Github repository.

  • asio.1.12.1.nupkg
  • tinyxml2.6.0.0.nupkg

Once these packages are downloaded, open an administrative shell and execute the following command:

choco install -y -s <PATH\TO\DOWNLOADS\> asio tinyxml2

Please replace <PATH\TO\DOWNLOADS> with the folder you downloaded the packages to.

Colcon installation


colcon is a command line tool to build sets of software packages. This section explains to use it to compile easily Fast-RTPS and its dependencies. First install ROS2 development tools (colcon and vcstool):

pip install -U colcon-common-extensions vcstool

Download the repos file that will be used to download Fast RTPS and its dependencies:

$ wget https://raw.githubusercontent.com/eProsima/Fast-RTPS/master/fastrtps.repos
$ mkdir src
$ vcs import src < fastrtps.repos

Finally, use colcon to compile all software:

$ colcon build

Manual installation


Before compiling manually Fast RTPS you need to clone the following dependencies and compile them using CMake.

    $ git clone https://github.com/eProsima/Fast-CDR.git
    $ mkdir Fast-CDR/build && cd Fast-CDR/build
    $ cmake ..
    $ cmake --build . --target install

    $ git clone https://github.com/eProsima/foonathan_memory_vendor.git
    $ cd foonathan_memory_vendor
    $ mkdir build && cd build
    $ cmake ..
    $ cmake --build . --target install

Once all dependencies are installed, you will be able to compile and install Fast RTPS.

$ git clone https://github.com/eProsima/Fast-RTPS.git
$ mkdir Fast-RTPS/build && cd Fast-RTPS/build
$ cmake ..
$ cmake --build . --target install

Documentation

You can access the documentation online, which is hosted on Read the Docs.

Quick Demo

For those who want to try a quick demonstration of Fast-RTPS libraries on Ubuntu, here is a way to launch an example application.

First, download and install docker application. Open a terminal and type the following command

$ sudo apt-get install docker.io

Then, download the docker image file from https://eprosima.com/index.php/downloads-all

Load the image and run it:

$ docker load -i ubuntu-fast-rtps.tar
$ docker run -it ubuntu-fast-rtps

You can run as many images as you want and check the communication between them.

Getting Help

If you need support you can reach us by mail at support@eProsima.com or by phone at +34 91 804 34 48.

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.