b89b5d91c4
* Pull in framework changes from data-products branch * Pull in changes to DpManager from data-products branch * Pull in DpWriter from data-products branch * Fix spelling * Revise FileNameString * Fix warnings in CI * Fix static analysis warnings * Fix static analysis warnings * Revise formatting and comments * Revise banner comments * Revise FileNameString per PR comment * Revise path names in config headers If a header H.hpp exists in the F Prime source base, then is dangerous. Because [project root] and [fprime root] are both in the list of include paths, it's not clear whether this means "include [project root]/config/H.hpp" or "include [fprime root]/config/H.hpp." On the other hand, or has no such ambiguity, because only one of [project root]/config and [fprime root]/config is in the list of include paths. * Revise path names in config headers If a header H.hpp exists in the F Prime source base, then `#include "config/H.hpp"` is dangerous. Because [project root] and [fprime root] are both in the list of include paths, it's not clear whether this means "include [project root]/config/H.hpp" or "include [fprime root]/config/H.hpp." On the other hand, include <config/H.hpp> or `#include "config/H.hpp"` has no such ambiguity, because only one of [project root]/config and [fprime root]/config is in the list of include paths.
A Flight-Proven, Multi-Platform, Open-Source Flight Software Framework
F´ (F Prime) is a component-driven framework that enables rapid development and deployment of spaceflight and other embedded software applications. Originally developed at the Jet Propulsion Laboratory, F´ has been successfully deployed on several space applications. It is tailored but not limited to small-scale spaceflight systems such as CubeSats, SmallSats, and instruments.
Please Visit the F´ Website: https://nasa.github.io/fprime for more information.
What does F´ provide
- An architecture that decomposes flight software into discrete components with well-defined interfaces
- A C++ framework that provides core capabilities such as message queues and threads
- Modeling tools for specifying components and connections and automatically generating code
- A growing collection of ready-to-use components
- Testing tools for testing flight software at the unit and integration levels.
Learn more about F' key features here.
System Requirements
- Linux, Windows with WSL, or macOS operating system
- git
- CMake 3.16+. CLI tool must be available on the system path.
- CLang or GNU C and C++ compilers (e.g. gcc and g++)
- Python 3.8+, virtual environments, and PIP
Getting Started
To get started with F´, install the F´ bootstrapping tool with:
pip install fprime-bootstrap
Then, create a new project with:
fprime-bootstrap project
See the HelloWorld Tutorial to guide you through all the steps of developing an F´ project.
New users are encouraged to read through the User Guide and explore the other tutorials.
Getting Help
Discussions
To ask questions, discuss improvements, and ask for help please use the project's GitHub Discussions.
Bug reports
To report bugs and issues, open an issue here.
Community
The F´ Community GitHub Organization contains third party contributions, more documentation of flight software development, and additional resources.
Resources
Release Notes
The version history and artifacts associated with the project can be found at Releases.