Skip to content

01.1 Project & Source Code Structure

AlexSp edited this page Apr 12, 2021 · 1 revision

project structure

The project contains the following files:

  • Core:
    Contains main source code. Generated folder.

    • BFFT:
      Source code that is written for the VCU by the BFF team. Contains C++ source as well as header files.
      • device:
        Device layer. Contains device classes.
      • double-buffering:
        Contains implementation for the data ingestion and caching using double buffering approach.
      • frutil:
        Stands for FreeRTOS Utils. Contains C++ code that wraps the FreeRTOS C-API-functions for more convenient use in C++ code.
      • middleware:
        Middleware layer that abstracts the generated code for the STM board. Contains communication implementation, e.g. CAN bus.
      • heap_useNewlib.h:
        Bugfix for the heap management implementation to be able to use FreeRTOS with dynamic heap allocation.
      • mymain.cpp, mymain.hpp:
        C++ main function that gets called from main.c. Currently (15.09.2020) contains code for experimental purposes, e.g. testing CAN communication.
    • Inc:
      Header files of generated code
    • Src:
      Source files of generated code
      • main.c:
        Contains the main function that serves as entry point of program
  • Drivers:
    Code provided by STM32CubeIDE

  • Middlewares:
    Code provided by STM32CubeIDE