Skip to main content

Prerequisites

The Signaling API requires payloads to:

  1. Run a linux operating system
  2. Have an ethernet connection to the satellite bus
  3. Have an SSH daemon running
  4. Provision a user for the Signaling API to use for SSH commands

Filesystem Conventions​

The Signaling API requires that certain conventions be followed when using the payload filesystem to place configuration files and uploaded data.

/usr/bin/payload_exec - Executable used by the satellite bus when signal commands are executed. Signaling API user must have execute permissions.

/signaling/inbox/ - Directory used by satellite bus to place uplinked files destined for the payload. Signaling API user must have write access.

/signaling/window_configs/ - Directory used by satellite bus to place window configuration .json files. Signaling API user must have write access.

Additional Permissions​

The Signaling API user must also have root or sudo privileges to perform a number of operations including but not limited to: altering the system clock for time synchronization, issuing halt/shutdown commands at the completion of a payload window.