Adding a new data decoder

From SatNOGS Wiki
Revision as of 20:33, 18 August 2018 by Kerel (talk | contribs) (Initial stub)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

How to create the parser for a new satellite downlink

For satellite downlinks where SatNOGS provides demodulated data, but no decoder exists yet.

  1. Find and read documentation of the satellite downlink.
  2. Extract raw frames either from satnogs-network or satnogs-db.
    • from network: Open good observations whith demodulated data,
      then open the observation via the API,
      copy the link to the payloads and download them (e.g. via wget)
    • from db: Export frames of your satellite (how?), then convert them from hex to raw
  3. Write the Kaitai Struct (.ksy-file)
    • Open the [Kaitai WebIDE](
    • Create a new .ksy-format file (press the empty sheet button in the lower left)
    • Upload the previously fetched raw frames as example data (press the cloud button in the lower left, select all files with raw frames)
    • Write the kaitai struct. Use already existing parsers for reference.
    • Always add the used documentation to the Kaitai struct (how?). If several sources are used, provide these sources when submitting the parser
    • Check the parsed output (object tree) for correctness
  1. Check the results of your parser
    • If another parser exists, cross-check your results with the output it provides.
    • Sometimes there are examples frames or examples recordings provided. Use them for verification (if the data is well-known.)
  1. Submit the created kaitai struct (how?)