Skip to main content

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. 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:

  • tm.meta
  • Verify that filter state can be computed from the CVT
{
  file_path: <file_path>,
  meta_path: <meta_file_path>,
  out: <the dir where files should be output to>,
  cvt_path: <path to cvt file>,
  filter_path: <path to filter definitions file>,
  model: <the mission's model>,
  timeslice_id: <int>, // needed?
  time_source: <pkt_or_grt>,
  raw: [],
  eng: [],
  sci: [],
}
Output

The output of the mission specific tool should be a xbin file, which XINA's tools will then process to generate the mining and export products.

Back to top