Adding a new data decoder - Revision history

Arneir77: update link to satblog

2022-08-15T17:59:34Z

update link to satblog

Kerel+satnogs: Add introduction with link to Satellite Operator Manual

2020-03-10T20:06:28Z

Add introduction with link to Satellite Operator Manual

Jebba: software decoders

2020-01-19T22:49:49Z

software decoders

Jebba: /* See also */ category

2020-01-19T21:33:12Z

‎See also: category

Jebba: /* See also / Decode Telemetry and Packets

2020-01-19T21:18:06Z

‎See also: * Decode Telemetry and Packets

Jebba: /* See also */ Remove empty telemetry category (for now?)

2020-01-19T21:12:29Z

‎See also: Remove empty telemetry category (for now?)

Jebba: Categories, layout

2020-01-19T21:11:54Z

Categories, layout

Kerel+satnogs: Add step for automated field definition generation

2019-04-14T19:34:39Z

Add step for automated field definition generation

Kerel+satnogs: Add link to dashboard creation

2019-04-14T18:31:06Z

Add link to dashboard creation

Kerel+satnogs: /* How to create the parser for a new satellite downlink */ imrove guide

2019-04-14T18:28:55Z

‎How to create the parser for a new satellite downlink: imrove guide

@@ Line 35: / Line 35: @@
 *[https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository
 *[[Decode Telemetry and Packets]]
-*[http://www.dk3wn.info/software.shtml Satellite specific telemetry decoders] (German)
+*[https://www.satblog.info/ Satellite specific telemetry decoders] (German)
 [[Category:Develop]]
 [[Category:Software]]
 [[Category:RF Modes]]

@@ Line 1: / Line 1: @@
-== How to create the parser for a new satellite downlink ==
+== Introduction ==
 For satellite downlinks where SatNOGS provides demodulated data, but no decoder exists yet.
-# Find and read documentation of the satellite downlink.
+#Find and read documentation of the satellite downlink.
-# Extract raw frames either from satnogs-network or satnogs-db.
+#Extract raw frames either from satnogs-network or satnogs-db.
-#* from network: Open good observations whith demodulated data,
+#*from network: Open good observations whith demodulated data,
-#*: then open the observation via the API,
+#*:then open the observation via the API,
-#*: copy the link to the payloads and download them (e.g. via wget)
+#*: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
+#*from db: Export frames of your satellite (how?), then convert them from hex to raw
-# Write the Kaitai Struct (.ksy-file)
+#Write the Kaitai Struct (.ksy-file)
-#* Open the [https://ide.kaitai.io/ Kaitai WebIDE]
+#*Open the [https://ide.kaitai.io/ Kaitai WebIDE]
-#* Create a new .ksy-format file (press the empty sheet button in the lower left)
+#*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)
+#*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 following the guide [https://community.libre.space/t/starting-with-satnogs-decoders/3145 "Starting with satnogs-decoders"] (TODO: Move this guide into this wiki) Use existing parsers from the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository for reference.
+#*Write the kaitai struct following the guide [https://community.libre.space/t/starting-with-satnogs-decoders/3145 "Starting with satnogs-decoders"] (TODO: Move this guide into this wiki) Use existing parsers from the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository for reference.
-#* The "doc:" section which defines all fields in front of the satnogs decoder kaitai structs can be ignored for now.  They are ignored by kaitai, satnogs-specific and will be auto-generated in a later step.
+#*The "doc:" section which defines all fields in front of the satnogs decoder kaitai structs can be ignored for now.  They are ignored by kaitai, satnogs-specific and will be auto-generated in a later step.
-#* Add a link to all the documentation of the satellite downlink which was used to write the kaitai struct (this can be done with a doc key)
+#*Add a link to all the documentation of the satellite downlink which was used to write the kaitai struct (this can be done with a doc key)
-# Check the results of your parser
+#Check the results of your parser
-#* If another parser exists, cross-check your results with the output it provides.
+#*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.)
+#*Sometimes there are examples frames or examples recordings provided. Use them for verification (if the data is well-known.)
-# Generate the fields definition using the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders/blob/master/contrib/generate_field_docstring.py generate-field-docstring.py script] (TODO: Add detailed documentation here and in the README)
+#Generate the fields definition using the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders/blob/master/contrib/generate_field_docstring.py generate-field-docstring.py script] (TODO: Add detailed documentation here and in the README)
-# Fork the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository and add your decoder as described in the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders/tree/master#adding-a-new-decoder README]
+#Fork the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository and add your decoder as described in the [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders/tree/master#adding-a-new-decoder README]
-# Create a commit with your new kaitai struct, push it to your fork and submit a Merge Request to satnogs-decoders
+#Create a commit with your new kaitai struct, push it to your fork and submit a Merge Request to satnogs-decoders
-# Done.
+#Done.
 Next step: [https://wiki.satnogs.org/Telemetry_Dashboards Add a dashboard to visualize the new data]
-== See also ==
+==See also==
 * [http://doc.kaitai.io/user_guide.html Kaitai Struct User Guide]
-* [https://ide.kaitai.io/ Kaitai WebIDE]
+*[http://doc.kaitai.io/user_guide.html Kaitai Struct User Guide]
-* [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository
+*[https://ide.kaitai.io/ Kaitai WebIDE]
-* [[Decode Telemetry and Packets]]
+*[https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository
-* [http://www.dk3wn.info/software.shtml Satellite specific telemetry decoders] (German)
+*[[Decode Telemetry and Packets]]
 [[Category:Develop]]
 [[Category:Software]]
 [[Category:RF Modes]]

@@ Line 31: / Line 31: @@
 * [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository
 * [[Decode Telemetry and Packets]]
 [[Category:Develop]]
 [[Category:Software]]
 [[Category:RF Modes]]

@@ Line 32: / Line 32: @@
 * [[Decode Telemetry and Packets]]
-[[Category:Development]]
+[[Category:Develop]]
 [[Category:Software]]
 [[Category:RF Modes]]

@@ Line 30: / Line 30: @@
 * [https://ide.kaitai.io/ Kaitai WebIDE]
 * [https://gitlab.com/librespacefoundation/satnogs/satnogs-decoders satnogs-decoders] repository
 [[Category:Development]]
-[[Category:Hardware]]
+[[Category:Software]]
 [[Category:RF Modes]]

← Older revision		Revision as of 21:12, 19 January 2020
Line 34:		Line 34:
	[[Category:Hardware]]		[[Category:Hardware]]
	[[Category:RF Modes]]		[[Category:RF Modes]]
−	~~[[Category:Telemetry]]~~

@@ Line 22: / Line 22: @@
 # Create a commit with your new kaitai struct, push it to your fork and submit a Merge Request to satnogs-decoders
 # Done.
 ==== Resources ====