PROVES Core Reference - Software Design Documents
Welcome to the PROVES Core Reference documentation site. This documentation provides comprehensive information for working with PROVES Core Reference, from getting started to detailed component design documents.
Overview
PROVES Core Reference is a reference software implementation combining F Prime (NASA's flight software framework) with Zephyr RTOS to create firmware for embedded flight control boards. The project targets ARM Cortex-M microcontrollers, specifically RP2350 (Raspberry Pi Pico 2) and STM32 boards.
Documentation Sections
Getting Started
Step-by-step guides to set up your development environment, build the firmware, and flash it to your board:
- Initial Setup
- Clone the repository and set up dependencies
- Build, Flash, and Run
- Build and deploy the firmware
Component Software Design Documents (SDDs)
Every component publishes its design document from its own docs/ folder. Browse them by category in the Component SDDs menu, starting with the Mode Manager.
Additional Resources
Troubleshooting guides and additional configuration information:
- Board List
- Tested boards and their configurations
- Specifying Board Configuration
- Troubleshooting
- WSL Notes
- Self-Hosted Runner Setup
Navigation
Use the Component SDDs tab above to browse the component SDDs. Each SDD includes:
- Introduction and purpose
- Requirements
- Design details
- Port definitions
- Command and event specifications
- Telemetry information
- Usage examples