Robotics & Autonomous Systems

Best practice for testing

This is a guide on how to write tests for iceoryx. It intends to cover the most common cases which will probably apply to 99% of tests. This shall not encourage to be more royalist than the king and common sense shall be

How optional and error values are returned in iceoryx

Many parts of the iceoryx C++ API follow a functional programming approach and allow the user to specify functions which handle the possible cases, e.g. what should happen when data is received.

QoS policies

Unlike other middlewares, e.g. DDS used in ROS 2https://docs.ros.org/en/galactic/Concepts/AboutQualityofServiceSettings.html, iceoryx keeps things simple and offers basic Quality of Service QoS settings. The QoS settings

Installation

All iceoryx libraries are deployed as independent CMake packages. Posh is using functions from hoofs and is depending on it. You are able to build posh and hoofs and integrate them into existing CMake projects.

Overview

This document covers the core functionality of Eclipse iceoryx and is intended to provide a quick introduction to setting up iceoryx applications.

What is Eclipse iceoryx?

The technology behind Eclipse iceoryx originated in the automotive domain. With the introduction of videobased driver assistance, the amount of data to be exchanged between different threads of execution increased to GBy

Welcome to iceoryx.io

Eclipse iceoryx™ is an interprocesscommunication middleware that enables virtually limitless data transmissions at constant time.

iceoryx vx.x.x

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/vx.x.x...vx.x.x

iceoryx v1.0.0

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v0.90.7...v1.0.0

iceoryx v.1.0.1

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v1.0.0...v1.0.1

iceoryx v.1.0.2

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v1.0.1...v1.0.2

iceoryx v2.0.0

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v1.0.2...v2.0.0

iceoryx v2.0.1

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v2.0.0...v2.0.1

iceoryx v2.0.2

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v2.0.1...v2.0.2

iceoryx v2.0.3

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v2.0.2...v2.0.3

iceoryx v2.0.4

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v2.0.3...v2.0.4

iceoryx v2.0.6

Full Changeloghttps://github.com/eclipseiceoryx/iceoryx/compare/v2.0.5...v2.0.6

Iceoryx C Language binding

If you are looking for an example take a look at the icedelivery on c example../iceoryxexamples/icedeliveryinc.

Gateway to DDS Networks

A gateway for bridging between iceoryx systems and DDS networks. The gateway enables iceoryx systems running on separate hosts to communicate with each other.

DDS Gateway Examples

Here you can find examples how to use the dds gateway in a real system. The examples use docker to simulate separated hosts running iceoryx.

List of examples

Listener or how to use callbacks with iceoryx

The Listener is threadsafe and can be used without restrictions. But be aware that all provided callbacks are executed concurrently in the background thread of the Listener. If you access structures inside this callback

Listener in C or how to use callbacks with iceoryx

The Listener is threadsafe and can be used without restrictions. But be aware that all provided callbacks are executed concurrently in the background thread of the Listener. If you access structures inside this callback

complexdata

To implement zerocopy data transfer we use a shared memory approach. This requires that every data structure needs to be entirely contained in the shared memory and must not internally use pointers or references. The com