Skip to content

Commit

Permalink
Writting sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitoria-b committed Nov 16, 2022
1 parent 3b76eac commit 9c82b22
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,9 @@ Overview
.. toctree::
:maxdepth: 3

overview
installation
telecommands_decoding
logfile
packaging
implementation
15 changes: 15 additions & 0 deletions docs/logfile.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**************
Logging System
**************

The Logging System of the Spacelab Decoder shows the events performed in the software - such as when a telecommand was decoded - and their respective date and time.


Operation
#########

The logfile is automatically generated inside a default folder in the user home page in the archives called "spacelab_decoder", but in the preferences of the software the user can choose in which folder to save the file.

The generated archive is a .csv file displaying date and time on one column and the event on the other one. The event can be a successfull decoding, an error or even the software startup.


38 changes: 38 additions & 0 deletions docs/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
########
Overview
########

The *Spacelab Decoder* is a Python in-development software to decode satellites telemetry from recorded audio file and subsequently real time decoding.

A list of known satellites that are planned to use this software so far are presented below:

* **FloripaSat-1** [1]_
* **GOLDS-UFSC (a.k.a. FloripaSat-2)** [2]_
* **Catarina-A1**

The satellites of the list above are developed (or in development) by the same research group: the *Space Technology Research Laboratory* (SpaceLab) [3]_, from *Universidade Federal de Santa Catarina* (Brazil).

The Software
============

.. image:: img/main-window.png
:width: 700

The objective of this software is to become the "universal" software of the Spacelab's Satellites to decode the data from any of its satellites.

The main ways to achieve that are

- to use a recorded audio file in the Wave format;
- and real time decoding using the an interface called Gqrx.

This application is written in Python, and is based on the experience gathered in the applications developed for the FloripaSat-1 mission. For telemetry encoding and transmission, there is also another application developed by the same research group, called *SpaceLab Transmitter* [4]_. The software also countains a logging system to register the events happening in the application.

More details of the software are described in the next sections of this documentation.

References
==========

.. [1] Marcelino, Gabriel M.; Martinez, Sara V.; Seman, Laio O., Slongo, Leonardo K.; Bezerra, Eduardo A. *A Critical Embedded System Challenge: The FloripaSat-1 Mission*. IEEE Latin America Transactions, Vol. 18, Issue 2, 2020.
.. [2] https://github.com/spacelab-ufsc/floripasat2-doc
.. [3] https://spacelab.ufsc.br/
.. [4] https://github.com/spacelab-ufsc/spacelab-transmitter
1 change: 1 addition & 0 deletions docs/telecommands_decoding.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
explain the wav and gqrx

0 comments on commit 9c82b22

Please sign in to comment.