eProsima projects documentation index

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 exposes an API to access the RTPS protocol directly, 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.

You can find all the library's source code on our GitHub repository.

The documentation is built using Sphinx, and it is hosted at Read the Docs. The online documentation generated with this project can be found in eProsima projects documentation index.

1. Installation Guide
2. Getting Started
3. Generating documentation in other formats
4. Running documentation tests
5. Contributing

Installation Guide

1. In order to build and test the documentation, some dependencies must be installed beforehand:

   sudo apt update
   sudo apt install -y \
       git \
       python3 \
       python3-pip \
       python3-venv \
       python3-sphinxcontrib.spelling \

2. Clone the repository

   cd ~
   git clone [email protected]:eProsima/all-docs.git all-docs

3. Create a virtual environment and install python3 dependencies

   cd ~/all-docs
   python3 -m venv all-docs-venv
   source all-docs-venv/bin/activate
   pip3 install -r source/requirements.txt

Getting Started

To generate the documentation in a HTML format for a specific branch of eProsima Shapes Demo run:

cd ~/all-docs
source all-docs-venv/bin/activate
make html

Generating documentation in other formats

The documentation can be generated in several formats such as HTML, PDF, LaTex, etc. For a complete list of targets run:

cd ~/all-docs
make help

Once you have selected a format, generate the documentation with:

cd ~/all-docs
source all-docs-venv/bin/activate
make <output_format>

Running documentation tests

This repository provides a set of tests that verify that:

1. The RST follows the style guidelines
2. There are no spelling errors
3. The HTML is built correctly

Run the tests by:

cd ~/all-docs
source all-docs-venv/bin/activate
make test

Contributing

If you are interested in making some contributions, either in the form of an issue or a pull request, please refer to our Contribution Guidelines.