# franca

**Repository Path**: tjopenlab/franca

## Basic Information

- **Project Name**: franca
- **Description**: https://github.com/franca/franca
A framework for defining and transforming interfaces
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-21
- **Last Updated**: 2024-07-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Welcome to Franca! ![Build Status](https://github.com/franca/franca/actions/workflows/build.yml/badge.svg)

Franca is a powerful framework for definition and transformation of software interfaces.
It is used for integrating software components from different suppliers, which are built based on various runtime frameworks, platforms and IPC mechanisms. The core of it is _Franca IDL_ (Interface Definition Language), which is a textual language for specification of APIs.

## Migration to github

As you are reading this, the migration of the Franca homepage and git repository to github is done.
The old page at EclipseLabs is still available (at least parts of it), but it will soon be switched
to read-only. Please clone or fork from the github repository, and also use the issue tracker available
on Franca's github site.

## Franca documentation and homepage

The latest Franca User Guide (incl. a reference chapter for the IDL) is available
[here](https://drive.google.com/folderview?id=0B7JseVbR6jvhUnhLOUM5ZGxOOG8).

More information about Franca can be found here: http://franca.github.io/franca
and in the wiki [on this page](https://github.com/franca/franca/wiki).

## Franca features

As Franca is based on Eclipse, there are some powerful tools which can be used to work with Franca. Most important, Franca offers a user-friendly editor for reviewing and editing Franca IDL files.

The following diagram shows the major benefits of using Franca.

![Franca benefits](https://projects.itemis.de/html/web-presentations/kbi/std/franca_std/resources/franca_feature_overview.png)

### Transformations and generation
Franca offers a framework for building transformations from/to other IDLs (e.g., D-Bus, OMG-IDL or others)
and code generation. We recommend using [Xtend](http://xtend-lang.org) for building the generators,
but it is generally possible to use other tools and languages which are based on EMF models or Java APIs for the task.

Support for the D-Bus Introspection format is available as installable feature of Franca.

### Specification of dynamic behavior ###
With Franca, the dynamic behavior of client/server interactions can be specified using _protocol state machines_.
Tools are available to use these specifications for validating implementations,
e.g., checking runtime traces against the expected order of events on the interface.
A graphical viewer for protocol state machines is part of Franca.

### Flexible deployment models
In specific application domains, it may be necessary to extend interface specifications by platform-
or target-specific information. This is supported by Franca's deployment models, which allow these kind
of extensions in a type-safe way.
Thus, role-based development workflows can be established: Platform architects own the deployment
specifications, whereas project architects and developers are responsible for providing the
platform-specific data for their actual interfaces.

### Rapid interface prototyping
Generate a test environment for your interface instantly and see your interface in action!
This is accomplished by generating [eTrice](http://eclipse.org/etrice) models from Franca interfaces
and generate executable Java code from these models. The test environment will consist of a client
component (acting as dynamic test case executor) and a server component (acting as an intelligent mock object).

## Franca and CommonAPI

If you want to generate C++ code directly from Franca interface specifications,
[CommonAPI C++](https://github.com/COVESA/capicxx-core-tools/) might be the proper solution.
It is designed to decouple generated API from the actual IPC stack and cooperates seamlessly with Franca.
CommonAPI was created in the context of the [GENIVI Alliance](http://genivi.org) initiative.
In summer of 2021, GENIVI has been transformed into [COVESA](https://www.covesa.global).

## Forum

For feedback and discussions around Franca there is a
Franca forum at Google Groups, see http://groups.google.com/group/franca-framework.

## Misc

There is an [online Franca presentation](https://projects.itemis.de/html/web-presentations/kbi/std/franca_std/) available.
This can also be used nicely from smartphones and tablets.

The Franca framework has been built using the open source projects [EMF](http://www.eclipse.org/emf),
[Xtext](http://www.xtext.org) and [Xtend](http://xtend-lang.org).
Thanks to all committers of those projects for their great and helpful contributions!

Build status on develop: ![Build Status](https://github.com/franca/franca/actions/workflows/build.yml/badge.svg?branch=develop)