Application Developer Guide

Warning

This software framework is still under construction and no stable version has been released yet. Features, protocols and the behavior of individual components may still change.

Introduction

• Listing Satellites in the Library
  • Inclusion in the Constellation Repository
  • Listing an External Satellite in the Library
• Development Tools
  • Formatting & Linting for C++
  • Using pre-commit
  • Software BOM with reuse

📚 Tutorials

• Creating a New Satellite
  • Getting Started
  • Installing Constellation
  • Building the Satellite
  • Implementing Functionality
• Implementing a Satellite (C++)
  • Implementing the FSM Transitions
  • Running and the Stop Token
  • To Reconfigure or Not To Reconfigure
  • Setting Status Messages
  • Error Handling
    • Generic Errors
    • Configuration Errors
• Implementing a satellite (Python)
  • The basic satellite class structure
  • Implementing the FSM Transitions
  • Running and the Stop Event
  • Error handling and shutdown
  • Troubleshooting
    • Satellite base functionality not working as expected

✏️ Adding Functionality

• Logging
• Sending Metrics
• Data Transmission
  • Transmitting Data
  • Data Format & Performance
  • Metadata
• Receiving Data in C++
  • Preparation: Validating Output Paths
  • Handling Data: Callbacks
• Custom Satellite Commands
  • The Command Registry
  • Registering The Command
  • Name and description
  • Command arguments and return values
  • Allowed FSM states

📖 How-To Guides

• Adding a Satellite to the Framework
• Porting a EUDAQ Producer
  • Porting the Finite State Machine Transitions
  • Transmitting Data
  • Adjusting the Logging Mechanism
  • Error Handling
• Increase Data Rate in C++