tangly-team/arm-device-app

vinci platform

Create a New Application

You want to create a new embedded application on an ARM microcontroller. Below the steps you need to use our libraries:

• Copy the vinci folder containing the abstractions for the actor based approach.

• Copy the vici-cmsis folder containing the implementation of the above abstractions with cmsis-os v2 official layer.

• Copy the sal-cmsis if you are interested in components for your periphery.

Optionally you can

• Copy the doctest folder for unit test support. The folder contains the official header of doctest. The vinci-tests folder contains examples of unit tests grouped in suites.

The CMakeLists.txt file contains examples how to compile the project, execute the unit tests, and generate the doxygen documentation.

Folder Structure

vinci

contains abstractions for the realtime functions and classes

vinci-cpp

implementation based on the C++ library

vinci-cmsis

implementation based on the CMSIS library

vinci-cmsis-simulation

implementation of the CMSIS library as a simulation in C++

A major goal is to avoid dynamic memory allocation and the usage of the heap. Programmers are free to use a heap, but the library does not require one.

CMake

The script compiles the tests and the demonstration application.

mkdir build                 (1)
cd build                    (2)
cmake ..                    (3)
make                        (4)
./VinciTest                 (5)
./Vinci                     (6)

1. Create the build directory for the project

2. Change into the build directory

3. Generate all local build files with cmake

4. Build all artifacts

5. Run the unit tests

6. Run the demonstration application

Generate Doxygen Documentation

You created your build directory and called cmake to generate all scripts. The next commands generate the documentation ^[1].

cd cmake-build              (1)
doxygen Doxyfiles.docs      (2)

1. Change into the build directory.

2. Generate the documentation. The files are located under ./html directory.

---

1. A message is printed if cmake cannot find your local doxygen installation.