Prom - Project Management in KIELER

Topics

Overview

The KIELER Compiler (KiCo) can generate different code targets from models. For example it is possible to generate C and Java code from an SCT file. As a result KIELER has to integrate with existing development tools and practices for the C and Java world. In the context of embedded systems, the target device also varies heavily.

Therefore the KIELER Project Management (Prom) has been developed. It eases the creation, compilation and deployment of projects, when using models that can be compiled via KiCo. Furthermore it eases the creation of wrapper code, which is used to initialize and run the model. To do so, there are mainly three components, Project Wizards, an Eclipse Launch Configuration and so called Environments, which will be introduces in the following.

The KiCo Launch Configuration

Todo

Prom Environments

Environments are used to set default settings for project creation and launching for different target platforms. They are configured in the preferences (Window > Preferences > KIELER > Environments).

An Environment consists of

1. a unique name, that does not contain a comma
2. a related project wizard
3. information about a main file for the project
4. information about the target code KiCo should produce from models
5. information for wrapper code generation
6. a list of shell commands which should be run as part of a project launch

Besides the name, all of these are optional, but can improve the workflow.

The related project wizard is run as part of the Prom project wizard and takes care of the actual project creation.

A main file typically contains the entry point of the program on the target environment. Its wrapper code initializes and runs the model and sets inputs and outputs to the physical components of the target device. To ease the project setup and because wrapper code for a specific target platform is often similar, it is possible to define default content for the main file. Therefore the field main file origin can contain an absolute file path to a file with the default contents of a newly created main file for this Environment. Furthermore predefined wrapper code snippets can be injected as part of a project launch, which is described below.

The desired programming language of KiCo generated code, can be set for an Environment. Further one can define the file extension (e.g. '.java' for Java files) for that language.

To generate wrapper code from a model one can define an input template and a directory with files that contain wrapper code snippets. The wrapper code origin is used to initialize the wrapper code snippet directory of a newly created project.

Last but not least, a list of shell commands can be defined, which will be executed sequentially when the code generation from KiCo and wrapper code generation both finished successfully. These commands are typically used to further compile the output and deploy the result to the target devide. As with names of Environments, the names of shell commands have to be unique and must not contain a comma.

Paths for initial content

Project Wizards with Prom

Todo

Wrapper Code Generation

Todo

Automatically generated files