fsfw_example_public/README.md

<img align="center" src=doc/images/FSFW_Logo_V3_bw.png width="50%">

# <a id="top"></a> <a name="linux"></a> FSFW Demo Application

This repository features a demo application. The example has been run successfully on the following 
platforms:

 - Linux host machine with the Linux OSAL or the Host OSAL
 - Windows with the Host OSAL
 - STM32H743ZI-Nucleo with the FreeRTOS OSAL
 - Raspberry Pi with the Linux OSAL
 - STM32H743ZI-Nucleo with the RTEMS OSAL
 
The purpose of this example is to provide a demo of the FSFW capabilities.
However, it can also be used as a starting point to set up a repository for
new flight software. It also aims to provide developers with practical examples
of how the FSFW is inteded to be used and how project using the FSFW should or can be
set up and it might serve as a basic test platform for the FSFW as well to ensure all OSALs are compiling
and running as expected.

The repository contains a Python TMTC program which can be used to showcase
the TMTC capabilities of the FSFW (currently, using the ECSS PUS packet standard).
 
## Reference

[Getting started with the Linux OSAL](doc/README-linux.md#top)<br>
[Getting started with the Host OSAL](doc/README-host.md#top)<br>
[Getting started with the FreeRTOS OSAL on a STM32](doc/README-stm32-freertos.md#top)<br>
[Getting started with the Raspberry Pi](doc/README-rpi.md#top)<br>
[Getting started with the Beagle Bone Black](doc/README-bbb.md#top)<br>
[Getting started with the RTEMS OSAL on a STM32](doc/README-stm32-rtems.md#top)<br>
[Getting started with Eclipse for C/C++](doc/README-eclipse.md#top)<br>
[Getting started with CMake](doc/README-cmake.md#top)<br>