https://github.com/covesa/capicxx-someip-tools

Common API C++ SOMEIP tooling
https://github.com/covesa/capicxx-someip-tools

Last synced: 8 months ago
JSON representation

Common API C++ SOMEIP tooling

• Host: GitHub
• URL: https://github.com/covesa/capicxx-someip-tools
• Owner: COVESA
• License: mpl-2.0
• Created: 2016-05-20T13:47:36.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-09T09:29:37.000Z (over 1 year ago)
• Last Synced: 2025-06-25T23:04:56.586Z (12 months ago)
• Language: Xtend
• Size: 3.68 MB
• Stars: 88
• Watchers: 25
• Forks: 53
• Open Issues: 12
• Metadata Files:
  • Readme: README
  • Changelog: CHANGES
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
IPC CommonAPI C++ SomeIP Tools

------------------------------

:doctitle: IPC CommonAPI C++ SomeIP Tools

:version:

Copyright

+++++++++

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

Copyright (C) 2015-2023, COVESA

This file is part of COVESA Project IPC Common API C++.

Contributions are licensed to the COVESA under one or more Contribution License Agreements or MPL 2.0.

License

+++++++

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

at http://mozilla.org/MPL/2.0/.

Version

+++++++

{version}

Build Instructions

~~~~~~~~~~~~~~~~~~

An automated build process via Maven for the update-site and the command line

interface is provided.

To build, change into the `org.genivi.commonapi.someip.releng` directory and

run:

----

mvn clean verify -DCOREPATH=< path to your CommonAPI-Tools dir> -Dtarget.id=org.genivi.commonapi.someip.target 

----

If no configuration files are changed, Maven should report successful

compilation of the following items:

----

org.genivi.commonapi.someip.releng

org.genivi.commonapi.someip.target

org.genivi.commonapi.someip

org.genivi.commonapi.someip.ui

org.genivi.commonapi.someip.feature

org.genivi.commonapi.someip.cli

org.genivi.commonapi.someip.cli.feature

org.genivi.commonapi.someip.cli.product

org.genivi.commonapi.someip.validator

org.genivi.commonapi.someip.validator.feature

org.genivi.commonapi.someip.updatesite

----

The command line interface will be built for different platforms, with a zip-file

as generated output. The zip-file can be found in

`org.genivi.commonapi.someip.cli.product/target/products`.

The unzipped results are located in

`org.genivi.commonapi.someip.cli.product/target/products/org.genivi.commonapi.someip.cli.product`

An osgi based application will be contained in the zip-file.

If the application is started without any parameters, the available commandline

parameters are printed. For example:

----

./org.genivi.commonapi.someip.cli.product/target/products/org.genivi.commonapi.someip.cli.product/linux/gtk/x86_64/commonapi-someip-generator-linux-x86_64

Command: Console Help

usage: commonapi-someip-generator-linux-x86_64 -h

 -h,--help   display help of available console commands

Command: Version Information

usage: commonapi-someip-generator-linux-x86_64 [-a | -p]  -v

 -a,--all       print code generator and plug-in versions

 -p,--plugins   print plug-in versions

 -v,--version   print code generator version

Command: CommonAPI Some/IP Code Generation

usage: commonapi-someip-generator-linux-x86_64 [-d ] [-dc ] [-dp

       ] [-ds ] [-l ] [-ll ] [-ng] [-np] [-ns] [-nsc] [-nv]

       [-pf] [-sp ] [-wod]

 -d,--dest                The default output directory

 -dc,--dest-common        The directory for the common code

 -dp,--dest-proxy         The directory for proxy code

 -ds,--dest-stub          The directory for stub code

 -l,--license             The file path to the license text that will be

                               added to each generated file

 -ll,--loglevel           The log level (quiet or verbose)

 -ng,--no-gen                  Switch off code generation

 -np,--no-proxy                Switch off generation of proxy code

 -ns,--no-stub                 Switch off generation of stub code

 -nsc,--no-sync-calls          Switch off code generation of synchronous methods

 -nv,--no-val                  Switch off validation of the fdepl file

 -pf,--printfiles              Print out generated files

 -sp,--searchpath         The search path to contain fidl/fdepl files

 -wod,--without-dependencies   Switch off code generation of dependencies

----