Schemas
parameters
The parameters field is a dictionary containing payload window type-specific tuning options. Each payload window type has different parameter sets.
Windows are configured via the parameters field. Different payload window types take different parameters.
user_command
| Name | Type | Required | Description |
|---|---|---|---|
| executable | string | yes | path to executable to run |
| executable_arguments | list of strings | yes | arguments to pass to executable |
adcs_config
The ADCS can operate in six modes "AUTONOMOUS", "NADIR", "TRACKING", "LINESCAN", "FIXED_PITCH" or "NOOP".
- In "AUTONOMOUS", the window has ADCS command control, but allows the ADCS module to autonomously engage in regular activities for power or thermal management activities.
- In "NADIR", the satellite points the specified aperture towards the center of the earth.
- In "TRACKING", the satellite points the specified aperture at a specific lat/lon coordinate on the surface of the earth.
- In "LINESCAN", the satellite points to NADIR, plus a roll angle, left or right from the orbital path
- In "FIXED_PITCH", the satellite points to NADIR, plus a pitch angle, forward or backward along the orbital path
- In "NOOP", no ADCS request is issued so this window does not compete for ADCS control during its execution.
If no "adcs_config" field is specified, the same behaviour as configuring "NOOP" mode should be expected.
| Name | Type | Required |
|---|---|---|
| mode | string | yes |
| target_latitude_north | number | if mode == "TRACKING" |
| target_longitude_east | number | if mode == "TRACKING" |
| aperture | string | if mode other than "NOOP" or "AUTONOMOUS" |
| yaw_deg | number | optional, if mode == "NADIR" |
| pitch_deg | number | optional, if mode == "NADIR" |
| roll_deg | number | optional, if mode == "NADIR" |
Valid modes are: "AUTONOMOUS", "NADIR", "TRACKING", "LINESCAN", or "FIXED_PITCH", "NOOP". Some valid apertures are: "VHF", "UHF", "ADSB", "GNSS", "SBAND_DEXTER", and "SBAND_SDR"
copy_from
The data needed to complete a window may exist on a different payload, commonly as the output of a previous command. To instruct the satellite controller to retrieve this data before executing the user command, these dependencies are listed a sequence of copy operations. Each copy operation indicates the following:
| Name | Type | Required | Description |
|---|---|---|---|
| src_payload | string | yes | "IPI", "SDR" or "SABERTOOTH" |
| src_path | string | yes | path |
| dst_path | string | yes | path |