Git Product home page Git Product logo

kyoungho / rticonnextdds-gateway Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rticommunity/rticonnextdds-gateway

0.0 1.0 0.0 3.4 MB

The RTI Gateway is a software component that allows integrating different types of connectivity protocols with DDS. Integration in this context means that data flows from different protocols are adapted to interface with DDS, establishing communication from and to DDS.

Home Page: https://community.rti.com/static/documentation/gateway/current/

License: Other

CMake 5.42% C++ 22.35% Python 3.19% C 69.04%

rticonnextdds-gateway's Introduction

RTI Connext Gateway

The RTI Connext® Gateway is a software component that allows integrating different types of connectivity protocols with DDS. Integration in this context means that data flows from different protocols are adapted to interface with DDS, establishing communication from and to DDS.

RTI Connext Gateway provides an open framework based on the RTI Routing Service SDK that enables users to easily add communication protocols as needed, in addition to any other protocol implementations that may be included as part of the framework.

Installation

RTI Connext Gateway is distributed in source format. You can clone the source repository using git:

git clone --recurse-submodule https://github.com/rticommunity/rticonnextdds-gateway.git

The --recurse-submodule option is required to clone additional third-party repositories as submodules.

If you forget to clone the repository with --recurse-submodule, simply run the following command to pull all the dependencies:

git submodule update --init --recursive

Building

Requirements:

In order to build the RTI Connext Gateway components you have to run the following command:

Linux® and macOS® systems

mkdir build
cd build
cmake .. -DCONNEXTDDS_DIR=/path/to/connextdds/installation/dir \
    -DCMAKE_INSTALL_PREFIX=../install
cmake --build . -- install

By default CMake builds debug artifacts. Debug libraries should be loaded and run with the debug version of Routing Service debug, which is located at:

$NDDSHOME/resource/app/bin/<architecture>/rtiroutingserviceappd

If you want to build them as 'release', you should add the following flag when calling CMake:

-DCMAKE_BUILD_TYPE=Release

Windows® systems

mkdir build
cd build
cmake .. -DCONNEXTDDS_DIR=/path/to/connextdds/installation/dir \
    -DCMAKE_INSTALL_PREFIX=../install \
    -DCMAKE_BUILD_TYPE=Debug|Release \
    -G <generator name>
cmake --build . --config Debug|Release --target install

The generator name comes from CMake, you can see a list of the Visual Studio® generators here: https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#id13

In case the architecture is 64 bits, we should also add -A x64. For example, the following option will generate a solution for Visual Studio 2015 64 bits:

-G "Visual Studio 14 2015" -A x64

For multi-configuration generator, such as Visual Studio solutions, we need to specify the configuration mode when building it:

--config Debug|Release

Documentation

The documentation can be found online in the following link: https://community.rti.com/static/documentation/gateway/current/index.html

Building Documentation Locally

Requirements:

NOTE: you may need to install manually sphinx_rtd_theme, breathe and docutils. See below how to install them.

  • Installing sphinx_rtd_theme 0.5.1:

    pip install sphinx_rtd_theme
  • Installing breathe:

    pip install breathe
  • Installing docutils:

    pip install docutils

In order to build the RTI Connext Gateway documentation, you have to add the RTIGATEWAY_ENABLE_DOCS flag when calling CMake:

mkdir build
cd build
cmake .. -DCONNEXTDDS_DIR=/path/to/connextdds/installation/dir \
    -DCMAKE_INSTALL_PREFIX=../install \
    -DRTIGATEWAY_ENABLE_DOCS=ON

The documentation will be generated under the install directory. The following file contains the RTI Connext Gateway documentation:

  • <RTI Connext Gateway folder>/install/doc/index.html

Specific documentation for the plugins can be found in the section 1.4. RTI Connext Gateway Plugins.

Further information about how to customize the build can be found in the section 4. Building from source.

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.

rticonnextdds-gateway's People

Contributors

akrassowski avatar angelrti avatar asorbini avatar gerardopardo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.