WIP: Struct Extract Interface

For projects that use telemetry data files (files of packets), XINA Mining (struct_mining) and Export (struct_export) delegates the decoding and conversion of mnemonic data to a mission specific tool.tool, which we will reference as struct_extract. This tool should implement the following interface for seamless integration with XINA.

Environment

• By default, a cmdline app with the name of struct_extract is executed and should be available from the PATH env of the user that executes the Mining Task.
• The app should be runnable on Ubuntu 22.04.
• If possible, the app should be self-contained and not have any external dependencies. However, the environment can be configured as needed if dependencies are required.

Input

The struct_extract app should accept

TODO:

a

single
• tm.meta
argument
• Verifywhich that filter state can be computed fromis the CVT
path

to

a JSON file. The JSON file defines all of the parameters needed to extract the desired mnemonic data. A JSON file is used to allow for flexibility without XINA being aware of the app's specific cmdline options. The following table defines the standard parameters:


Note: If {
  file_path: <file_path>raw, meta_path: <meta_file_path>eng, out:or <thesci dirare wherenot filesprovided, all mnemonics should be outputextracted to>,as cvt_path:"science".
<



















































Key
Required
Description
dir
✓
The path to cvtthe dir containing the archive file>, filter_path:and <any ancillary files needed for processing
dest
✓
The path to filterthe definitionsdir that all output (e.g. xbin file) should be placed
mission
✓
TBC: The mission which may be needed to determine how the archive file>, model:is <theprocessed
model
✓
TBC: The mission's model>, timeslice_id:which <int>,may //be needed?needed time_source:to <pkt_or_grt>,determine raw:how [],the eng:archive [],file sci:is [],processed
raw
The mnemonic IDs of the mnemonics that should be extracted and output, unconverted
eng
The mnemonic IDs of the mnemonics that should be extracted and output with the engineering conversion applied
sci
The mnemonic IDs of the mnemonics that should be extracted and output with the science conversion applied
time_mode
For projects that support it, defines which time source should be used for the mnemonic data. Either "pkt" or "grt" (ground receipt time). If not provided, it should default to packet time.

Example JSON configuration file:

{
}

Output
The output of the mission specific tool should be a xbin file, which. XINA's tools will then process the xbin file to generateproduce the miningrequired andmine or export products.
struct_extract should output mission specific data using one of the following options:


Self generate the data file and the corresponding XINA JSON import file. XINA will take care of importing the data.

Output the data into the xbin file. XINA will take care of the rest.