Quickstart#

Prerequisites#

To build and run iceoryx2, you will need to install the following packages on your operating system:

  • gcc and g++ compiler (stable)

  • clang compiler (stable)

Run an Example#

  1. Clone the iceoryx2 repository:

    git clone git@github.com:eclipse-iceoryx/iceoryx2.git

  2. Navigate to the cloned repository:

    cd iceoryx2

  3. Try an example from the examples folder

    1. Terminal A

      cargo run --example publish_subscribe_subscriber

    2. Terminal B

      cargo run --example publish_subscribe_publisher

Add iceoryx2 to your project#

If working with cargo, then iceoryx2 can be added to your project with:

cargo add iceoryx2

Alternatively, you can manually add the desired version to your project’s Cargo.toml:

[dependencies]
iceoryx2 = "0.7.0"

The iceoryx2 Python bindings can be pulled into your project from the Python Package Index. You can install it into your environment with:

pip install iceoryx2

Alternatively, the package can be added as a dependency using whichever dependency management solution used by your project.

For Poetry projects:

The dependency can be added with:

poetry add iceoryx2

For projects using requirements.txt:

Add the desired version to your requirements.txt:

iceoryx2==0.7.0

In order to use iceoryx2 in your C++ project, the C++ bindings to iceoryx2 must be built.

From the iceoryx2 repository root, execute the following:

cmake -S . -B target/ff/cc/build
cmake --build target/ff/cc/build
cmake --install target/ff/build --prefix target/ff/install # or some other location

Then, make the installed headers and libraries available to your project using one of these methods:

For CMake projects:

Set the CMAKE_PREFIX_PATH to include the install location:

set(CMAKE_PREFIX_PATH "/path/to/prefix" ${CMAKE_PREFIX_PATH})
find_package(iceoryx2 REQUIRED)
target_link_libraries(your_target iceoryx2-cxx)

Or pass it via command line:

cmake -DCMAKE_PREFIX_PATH=/path/to/prefix ...

For other build systems:

  • Add the include directory: /path/to/prefix/include

  • Add the library directory: /path/to/prefix/lib

  • Link against the built iceoryx2 library

In order to use iceoryx2 in your C project, the C bindings to iceoryx2 must be built.

From the iceoryx2 repository root, execute the following:

cmake -S . -B target/ff/cc/build -DBUILD_CXX=OFF
cmake --build target/ff/cc/build
cmake --install target/ff/build --prefix target/ff/install # or some other location

Then, make the installed headers and libraries available to your project using one of these methods:

For CMake projects:

Set the CMAKE_PREFIX_PATH to include the install location:

set(CMAKE_PREFIX_PATH "/path/to/prefix" ${CMAKE_PREFIX_PATH})
find_package(iceoryx2 REQUIRED)
target_link_libraries(your_target iceoryx2-c)

Or pass it via command line:

cmake -DCMAKE_PREFIX_PATH=/path/to/prefix ...

For other build systems:

  • Add the include directory: /path/to/prefix/include

  • Add the library directory: /path/to/prefix/lib

  • Link against the built iceoryx2 library