Merge pull request #22 from spacelab-ufsc/dev

Dev

.github/workflows/test.yml

@@ -0,0 +1,58 @@
+#
+#  test.yml
+#  
+#  Copyright The SpaceLab-Decoder Contributors.
+#  
+#  This file is part of SpaceLab-Decoder.
+#
+#  SpaceLab-Decoder is free software; you can redistribute it
+#  and/or modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation, either version 3 of the
+#  License, or (at your option) any later version.
+#  
+#  SpaceLab-Decoder is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public
+#  License along with SpaceLab-Decoder; if not, see <http://www.gnu.org/licenses/>.
+#  
+#
+
+
+name: Unit tests
+
+on:
+  push:
+    branches: [dev]
+  pull_request:
+    branches: [master, dev]
+
+  # 'workflow_dispatch' allows manual execution of this workflow under the repository's 'Actions' tab
+  workflow_dispatch:
+
+jobs:
+
+  unit-tests:
+    name: Unit tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v3
+
+      - name: Install dependencies
+        run: sudo apt install -y python3 python3-dev python3-gi python3-gi-cairo libcairo2-dev libgirepository1.0-dev gir1.2-gtk-3.0 libgtk-3-dev sphinx-common sphinx-rtd-theme-common xvfb python3-pytest python3-pytest-xvfb
+
+      - name: Install Python dependencies
+        run: python -m pip install --upgrade pip PyGObject pytest-xvfb
+
+      - name: Execute the tests
+        run: |
+         Xvfb :1 &
+         export DISPLAY=:1
+         pytest-3 tests/

README.md

@@ -28,12 +28,15 @@
 
 SpaceLab Packet Decoder is a software to decode audio records from the satellites of SpaceLab.
 
+<img src="docs/img/main-window.png" width=""/>
+
 ## Satellites
 
 Until now, this program supports the satellites below:
 
 * FloripaSat-1 (launched in December 2019)
 * FloripaSat-2 (to be launched on 2022)
+* Aldebaran-1 (to be launched on TBC)
 
 ## Dependencies
 
@@ -43,6 +46,7 @@ Until now, this program supports the satellites below:
 * pyzmq
 * matplotlib
 * gnuradio
+* pyngham
 
 ### Installation on Ubuntu
 
@@ -54,14 +58,12 @@ Until now, this program supports the satellites below:
 
 ## Building and Installing
 
-Before installing the main Python application, the NGHam library must be compiled and installed in the system:
-
-* ```make```
-* ```make install```
 * ```python setup.py install```
 
 ## Documentation
 
+The documentation page is available [here](https://spacelab-ufsc.github.io/spacelab-decoder/). Instructions to build the documentation page are described below.
+
 ### Dependencies
 
 * sphinx-rtd-theme

docs/index.rst

@@ -13,4 +13,9 @@ Overview
 .. toctree::
    :maxdepth: 3
 
+   overview
+   installation
+   telecommands_decoding
+   logfile
    packaging
+   implementation

docs/logfile.rst

@@ -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. 
+
+

docs/overview.rst

@@ -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

docs/telecommands_decoding.rst

@@ -0,0 +1 @@
+explain the wav and gqrx