User Manual

The User Manual provides comprehensive documentation for understanding and using F Prime.

[!TIP] ← Navigation pane
Use the navigation pane on the left to explore the different chapters of the User Manual documentation. If the navigation pane is not visible, click on the menu icon (three horizontal lines) at the top left corner of the page. The navigation pane is hidden on narrow screens or if zoomed in.

Table of Contents

<details markdown="1"> <summary><strong>Overview</strong> — Technical overview of the F´ ecosystem.</summary>

• Introduction To F´
• F´ Software Architecture
• Core Constructs: Ports, Components, and Topologies
• Data Constructs: Commands, Events, Channels, and Parameters
• Data Structures and Types
• F´ Development Process
• The F´ Ground Data System
• Projects and Deployments
• A Tour of the Source Tree
• Unit Testing in F´

</details> <details markdown="1"> <summary><strong>Framework</strong> — Learn concepts and mechanisms needed to build and use an F´ application.</summary>

• Asserts in F
• F´ Autocoded Functions and Component Classes
• Constructing the F´ Topology
• Selecting Component, Port, and Command Kinds
• Configuring F´
• Data Products
• Ground Interface Architecture and Customization
• Memory Management
• F´ Reference Projects
• F´ on Baremetal Systems
• F´ on Multi-Core Systems
• State Machines
• Supported Platforms

</details> <details markdown="1"> <summary><strong>GDS</strong> — Learn how to use the F Prime Ground Data System, and how it can be used to test F´ applications.</summary>

• The F´ GDS CLI
• The GDS Dashboard
• GDS Dashboard Component Reference
• GDS Developer's Guide
• GDS Integration Test API
• Reusable Integration Tests
• Sequencing In F´

</details> <details markdown="1"> <summary><strong>Design Patterns</strong> — Learn about common design patterns used in F´ applications.</summary>

• Application-Manager-Driver Architecture
• Common Port Design Patterns
• Health Checking Pattern
• A Quick Look at the Hub Pattern
• The Manager/Worker Pattern
• Rate Groups and Timeliness
• Subtopologies

</details> <details markdown="1"> <summary><strong>Build System</strong> — Learn about the F´ build system and how to customize it.</summary>

• F´ CMake Build System
• CMake API Reference
• CMake Customization
• CMake Implementations
• F´ and CMake Platforms
• Targets
• CMake Toolchain Files
• CMake Build System Unit Tests
• settings.ini: Build Settings Configuration

</details> <details markdown="1"> <summary><strong>Security</strong> — Security considerations when designing and developing F´ applications.</summary>

• Software Bill Of Materials Generation

</details>