Framework Developer Guide

Note

This section of the manual contains technical details not required for understanding and operating Constellations, but only for implementing Constellation libraries in different languages, or for consulting the available APIs

General

• Contributing
  • Getting Access to the DESY GitLab
  • Setting up the Development Environment
    • Pre-commit Hooks
    • Development Dependencies
  • Running the Test Suite
    • Running Coverage Checks
  • Building the Documentation
    • Adding Blog Posts
• Building as Flatpak
  • Setting up Flatpak
  • Preparing the Flatpak
  • Building the Flatpak
• Release Process
  • Updating the Version and Code Name
  • Publishing the Release Notes
  • Updating the Metadata
  • Creating the Release
  • Releasing on Flathub

Technical Documentation

• Satellite Implementation Guidelines
  • Names
  • Satellite Startup & Shutdown
  • Satellite Commands
  • FSM States
  • FSM State & Transition Diagram
  • Autonomous Transitions
  • Data Sending and Receiving
• Naming Conventions & Case Sensitivity
  • User Input is Case-Insensitive
  • Public Names
  • Code Naming Conventions
• Communication Protocols
  • Autonomous Operation
  • Command & Controlling
  • Data Transmission
  • Monitoring
  • Network Discovery

C++ Developer API

• Core Library
  • Logging
  • Configuration
  • Telemetry
  • Messages
  • Utilities
  • Protocols
  • Heartbeat Protocol Implementation
  • CHIRP
  • Pools
  • Networking
• Satellite Library
  • Satellite
• Controller Library
  • Controller
• Listener Library
  • Listener

Appendix

• Protocols
  • CHIRP
  • CHP
  • CSCP
  • CMDP
  • CDTP