Skip to content

Latest commit

 

History

History
161 lines (108 loc) · 5.54 KB

installation.rst

File metadata and controls

161 lines (108 loc) · 5.54 KB

Installation

In this section, instructions are provided to install the following packages:

The user can decide wether to install the Agent and Client as stand-alone packages, or together. If the first approach is chosen, refer to the :ref:`Release Notes <notes_label>` section in order to match versions that are compatible.

Using pre-installed docker images

Download here the Micro XRCE-DDS and Fast-DDS Suite docker image that contains a pre-installed client and agent as well as some compiled examples. More information about this Docker image can be found :ref:`here <eprosima_docker_image>`.

Installing the Agent standalone

Clone the project from GitHub:

$ git clone https://github.com/eProsima/Micro-XRCE-DDS-Agent.git
$ cd Micro-XRCE-DDS-Agent
$ mkdir build && cd build

On Linux, inside of the build folder, execute the following commands:

$ cmake ..
$ make
$ sudo make install

On Windows first select the Visual Studio version:

$ cmake -G "Visual Studio 15 2017 Win64" ..
$ cmake --build .
$ cmake --build . --target install

Note

The eProsima Micro XRCE-DDS Agent can be configured at compile-time via several CMake definitions. Find them listed in the :ref:`agent_configuration` section of the :ref:`micro_xrce_dds_agent_label` page.

Now the the executable eProsima Micro XRCE-DDS Agent is installed in the system. Before running it, add /usr/local/lib to the dynamic loader-linker directories.

sudo ldconfig /usr/local/lib/

Important

The eProsima Micro XRCE-DDS Agent executable comes with a rich CLI. Find out all the options offered by this CLI when running the Agent in the :ref:`agent_cli` section of the :ref:`micro_xrce_dds_agent_label` page.

Installation from Snap package

The eProsima Micro XRCE-DDS Agent can also be installed as a Snap package..

To this aim, simply execute sudo snap install micro-xrce-dds-agent in the console. This will download the Snap package corresponding to the stable version, that is, the master branch on GitHub.

For downloading the Snap image corresponding to the develop branch, add the --edge flag to the installation command.

Note

The Snap package is only available for Linux.

Installing the Client standalone

Clone the project from GitHub:

$ git clone https://github.com/eProsima/Micro-XRCE-DDS-Client.git
$ cd Micro-XRCE-DDS-Client
$ mkdir build && cd build

On Linux, inside of build folder, execute the following commands:

$ cmake ..
$ make
$ sudo make install

Now the the executable eProsima Micro XRCE-DDS Client is installed in the system. Before running it, add /usr/local/lib to the dynamic loader-linker directories.

sudo ldconfig /usr/local/lib/

On Windows first select the Visual Studio version:

$ cmake -G "Visual Studio 15 2017 Win64" ..
$ cmake --build .
$ cmake --build . --target install

Note

In order to install the eProsima Micro XRCE-DDS Client examples, add -DUCLIENT_BUILD_EXAMPLES=ON to the cmake .. command-line options. This flag will enable the compilation of the examples. In addition to this flag, there are several other CMake definitions for configuring the building of the client library at compile-time. Find them in the :ref:`profiles` and configurations sections of the :ref:`micro_xrce_dds_client_label` page.

For building a Client app in the host machine, compile against the following libs:

gcc <main.c> -lmicrocdr -lmicroxrcedds_client

Installing the Micro XRCE-DDS Gen tool

:ref:`Install dependencies<dependencies_label_gen>`, clone the project from GitHub and build:

$ git clone https://github.com/eProsima/Micro-XRCE-DDS-Gen.git
$ cd Micro-XRCE-DDS-Gen
$ git submodule init
$ git submodule update
$ ./gradlew assemble

The Micro XRCE-DDS-Gen tool will be available as:

$ ./scripts/microxrceddsgen -help

Installing Agent and Client

Clone the project from GitHub:

$ git clone https://github.com/eProsima/Micro-XRCE-DDS.git
$ cd Micro-XRCE-DDS
$ mkdir build && cd build

On Linux, inside of the build folder, execute the following commands:

$ cmake ..
$ make
$ sudo make install

On Windows choose the Visual Studio version using the CMake option -G, for example:

$ cmake -G "Visual Studio 15 2017 Win64" ..
$ cmake --build . --target install

Now both the eProsima Micro XRCE-DDS Agent and the eProsima Micro XRCE-DDS Client are installed in the system.

Note

In order to install the eProsima Micro XRCE-DDS Gen tool as well, add -DUXRCE_ENABLE_GEN=ON to the cmake .. command-line options. This flag will enable the downloading and compilation of the code generating tool.

Note

In order to install the eProsima Micro XRCE-DDS examples, add -DUXRCE_BUILD_EXAMPLES=ON to the cmake .. command-line options. This flag will enable the compilation of the examples.