Repository files navigation

Copyright (C) 2015-2024, Bayerische Motoren Werke Aktiengesellschaft (BMW AG)

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.If a copy of the MPL was not distributed with this file, You can obtain one athttp://mozilla.org/MPL/2.0/.

For comprehensive details on how to contribute effectively to the project, please refer to ourCONTRIBUTING.md file.

The vSomeIP stack implements thehttp://some-ip.com/ (Scalable service-Oriented MiddlewarE over IP (SOME/IP)) Protocol.The stack consists out of:

• a shared library for SOME/IP (libvsomeip3.so)
• a shared library for SOME/IP's configuration module (libvsomeip3-cfg.so)
• a shared library for SOME/IP's service discovery (libvsomeip3-sd.so)
• a shared library for SOME/IP's E2E protection module (libvsomeip3-e2e.so)

Optional:

• a shared library for compatibility with vsomeip v2 (libvsomeip.so)

• A C++17 enabled compiler is needed.
• vSomeIP uses CMake as buildsystem.
• vSomeIP uses Boost >= 1.66.0:

For the tests Google's test frameworkhttps://code.google.com/p/googletest/[gtest] is needed.-- URL:https://googletest.googlecode.com/files/gtest-.zip

To build the documentation doxygen and graphviz are needed:--sudo apt-get install doxygen graphviz

For compilation call:

mkdir buildcd buildcmake ..make

To specify a installation directory (like--prefix= if you're used to autotools) call cmake like:

cmake -DCMAKE_INSTALL_PREFIX:PATH=$YOUR_PATH ..makemake install

To predefine the unicast address, call cmake like:

cmake -DUNICAST_ADDRESS=<YOUR IP ADDRESS> ..

To predefine the diagnosis address, call cmake like:

cmake -DDIAGNOSIS_ADDRESS=<YOUR DIAGNOSIS ADDRESS> ..

The diagnosis address is a single byte value.

To change the default configuration folder, call cmake like:

cmake -DDEFAULT_CONFIGURATION_FOLDER=<DEFAULT CONFIGURATION FOLDER> ..

The default configuration folder is/etc/vsomeip.

To change the default configuration file, call cmake like:

cmake -DDEFAULT_CONFIGURATION_FILE=<DEFAULT CONFIGURATION FILE> ..

The default configuration file is/etc/vsomeip.json.

To compile vSomeIP with signal handling (SIGINT/SIGTERM) enabled, call cmake like:

cmake -DENABLE_SIGNAL_HANDLING=1 ..

In the default setting, the application has to take care of shutting down vSomeIP in case these signals are received.

If you encounter build issues on Ubuntu 24.04, consider using Ubuntu 22.04 as a temporary fix. This is due to the ongoing transition of the GitHub Actions runner to Ubuntu 24.04, which may cause compatibility issues.

• vSomeIP uses Boost >= 1.66. The boost libraries (system, thread and log) must be included in the Android source tree and integrated into the build process with an appropriate Android.bp file.

In general for building the Android source tree the instructions found on the pages from the Android Open Source Project (AOSP) apply (https://source.android.com/setup/build/requirements).

To integrate the vSomeIP library into the build process, the source code together with the Android.bp file has to be inserted into the Android source tree (by simply copying or by fetching with a custom platform manifest).When building the Android source tree, the Android.bp file is automatically found and considered by the build system.

In order that the vSomeIP library is also included in the Android image, the library has to be added to the PRODUCT_PACKAGES variable in one of a device/target specific makefile:

PRODUCT_PACKAGES += \    libvsomeip \    libvsomeip_cfg \    libvsomeip_sd \    libvsomeip_e2e \

• Visual Studio Code
• Visual Studio Build Tools with:
  • Desktop development with C++
  • MSVC v143 - VS 2022 C++ x64/x86 build tools
  • Windows 10/11 SDK
  • CMake for Windows
• vSomeIP uses CMake as buildsystem.
• vSomeIP uses Boost >= 1.71.0:
• GIT

For the tests Google's test frameworkhttps://code.google.com/p/googletest/[gtest] is needed.-- URL:https://googletest.googlecode.com/files/gtest-.zipor-- git clonehttps://github.com/google/googletest.git

For compilation call:

rmdir /s /q buildcd buildcmake .. -A x64 -DCMAKE_INSTALL_PREFIX:PATH=$YOUR_PATHcmake --build. --config [Release|Debug]cmake --build. --config [Release|Debug] --target install

For compilation outside vsomeip-lib folder call:

rmdir /s /q buildcmake -B"buildlib" -DCMAKE_BUILD_TYPE=[Release|Debug] -DCMAKE_INSTALL_PREFIX=$YOUR_PATH -A x64 vsomeip-lib#vsomeip-lib compilationcmake --build build --config [Release|Debug] --parallel 16 --target install#examples compilationcmake --build build --config [Release|Debug] --parallel 16 --parallel 16 --target examplescmake --build build --config [Release|Debug] --parallel 16 --target install#unit-tests compilationcmake --build build/test --config [Release|Debug] --parallel 16 --parallel 16 --target build_unit_tests#all tests compilationcmake --build build/test --config [Release|Debug] --parallel 16 --parallel 16 --target all build_tests