Introduction

CommonAPI C++ Examples, version 1.0.0, is an example integration and playground of a client and server architecture using the COVESA / GENIVI Common API C++ Framework, covering both runtimes and code generators and also supporting both D-Bus and SOME/IP bindings.

For convenience, a list of relevant repositories and resources from the relevant organizations is listed below. These resources are the latest at the time of writing, and the ones used for the development of this project.

• COVESA / GENIVI Common API C++ Core Tools v3.2.15 repository

  • Common API C++ Core Tools v3.2.15 Specification

  • Common API C++ Core Tools v3.2.15 User Guide

  • Common API C++ Core Tools v3.2.15 Deployment Specification

• COVESA / GENIVI Common API C++ D-Bus Tools v3.2.15 repository

  • Common API C++ D-Bus Tools v3.2.15 User Guide

  • Common API C++ D-Bus Tools v3.2.15 Deployment Specification

• COVESA / GENIVI Common API C++ SOME/IP Tools v3.2.15 repository

  • Common API C++ SOME/IP Tools v3.2.15 User Guide

  • Common API C++ SOME/IP Tools v3.2.15 Deployment Specification

• COVESA / GENIVI vSomeIP v3.5.3 repository

  • vSomeIP v3.5.3 User Guide

• COVESA / GENIVI Common API C++ Core Runtime v3.2.4 repository

• COVESA / GENIVI Common API C++ D-Bus Runtime v3.2.3-r1 repository

• COVESA / GENIVI Common API C++ SOME/IP Runtime v3.2.4 repository

• Franca User Guide v0.12.0.1

It is recommended to first refer to the Application to understand the client/server architecture, followed by the Common API C++ Abstraction to understand the Common API C++ framework integration. The Test Suites provide some practice examples and a playground for experimentation and testing of the different features of the Common API C++ framework.

The source code for CommonAPI C++ Examples is hosted at Github and related Docker images for development containers are located at DockerHub. Test Results HTML Report and Code Coverage HTML report are also available.

Note

This is the documentation for CommonAPI C++ Examples, version 1.0.0, refer to Version for more details regarding the release.

Important

This project is an open source project built from publicly available repositories and documentation and not affiliated with COVESA / GENIVI.

This project is an example integration of the Common API C++ Framework based on previous experience and interpretation of the author of that documentation.

License

Copyright 2025 - Diego Martínez García <dmg0345@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.