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

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
  • Heartbeating
  • Command & Controlling
  • Data Transmission
  • Monitoring
  • Network Discovery

C++ Developer API

• Core Library
  • Logging
  • Configuration
  • Messages
  • Utilities
  • Protocols
  • Heartbeating
  • CHIRP
  • Pools
• Satellite Library
  • Satellite
• Controller Library
  • Controller

Appendix

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