Skip to main content

Payload Signaling API

The Signaling API defines the interface that payloads must expose for the satellite bus to inform the payloads of upcoming events.

The API consists of:

  • A payload executable used to respond to satellite bus events. This executable will be called by the bus using SSH.
  • Conventions for where window configuration files and uplinked files are placed on the payload file system by the satellite bus.
  • Window configuration file schemas provided by the satellite bus for payload executables to use. These window configuration files contains bus information about the signal as well as relevant data passed through from the Tasking API.
  • Argument schemas that payload executables must accept to handle satellite bus signals.
  • Transmission of data from the payload to the ground is handled via the OORT Agent process on the payload.

It is the responsibility of the payload to implement an executable that can be called with certain parameters after the window configuration file is placed on the payload file system. This executable will interpret the window configuration file and perform the necessary payload actions.