From 5220bc916811d62807ca78a47ec52ccafc7d6969 Mon Sep 17 00:00:00 2001 From: CarlWachter Date: Thu, 14 Dec 2023 10:25:42 +0100 Subject: [PATCH] Updated README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 99bb72e..9e8408d 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,44 @@ This is the Trajectory Analysis Control OS (TACOS) that serves as a starting poi ## Setting Up TACOS -Clone the repository using `--recurse-submodules` and open it in STM32CubeIDE via `File` -> `Open Projects from File System...`. Next, right click the project's root in STM32CubeIDE and open its properties via `Properties`. +Clone the repository using `--recurse-submodules` and then add it to an existing CubeIDE project. Be sure to add the include paths for Tacos, sta-core and rtos2-utils to the project with the following steps: +``` +Properties -> C/C++ General -> Paths and Symbols -> Includes -> GNU C -> Add... +``` + +## Configuring TACOS +Be sure to add a "config.hpp" to the App/Inc/sta directory. This file could look like this: +``` +#ifndef INC_STA_CONFIG_HPP_ +#define INC_STA_CONFIG_HPP_ + +// Use the STM32F411 microprocessor. +#include + +// Doesn't really do too much right now. Has to be added for successful compilation. +#define STA_PRINTF_USE_STDLIB + +// Enable debug serial output and assertions. +#define STA_ASSERT_FORCE +#define STA_DEBUGGING_ENABLED + +// Activate the timer for microsecond delays. +// #define STA_STM32_DELAY_ENABLE +// #define STA_STM32_DELAY_US_TIM htim1 + +// Settings for the rtos-utils +#define STA_RTOS_SYSTEM_EVENTS_ENABLE +// #define STA_RTOS_SYSTEM_WATCHDOG_ENABLE +// #define STA_RTOS_WATCHDOG_ENABLE + + +// Settings for TACOS +#define STA_TACOS_MANAGER_PRIORITY osPriorityNormal +#define STA_TACOS_STATEMACHINE_PRIORITY osPriorityNormal + +// Statemachine settings. Here, we only have a single state which is also the initial state. +#define STA_TACOS_NUM_STATES 3 +#define STA_TACOS_INITIAL_STATE 0 + +#endif /* INC_STA_CONFIG_HPP_ */ +```