Skip to content

Commit

Permalink
Starting the documentation #90
Browse files Browse the repository at this point in the history
  • Loading branch information
vitoria-b committed Aug 15, 2022
1 parent d43d96e commit a5268a3
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 14 deletions.
46 changes: 43 additions & 3 deletions docs/Overview.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
********
########
Overview
********
########

.. image:: enterprise.png
:target: https://www.youtube.com/watch?v=JaDpDG2fYtY
Expand All @@ -15,9 +15,49 @@ A list of known satellites that are planned to use this software are presented b
* **Catarina-A1**


The two 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 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/front_page.png
:width: 700

The objective of this software is to become the "universal" software of the Spacelab's Satellites to transmit packages to any of its satellites.
As it is first focused on GOLDS-UFSC, right when we run the software we can see 14 buttons with the respective telecommands of this sattelite:

+-------------------+------------+
| Telecommand | Function |
+===================+============+
| Ping Request | |
+-------------------+------------+
| Data Request | |
+-------------------+------------+
| Broadcast Message | |
+-------------------+------------+
| Enter Hibernation | |
+-------------------+------------+
| Leave Hibernation | |
+-------------------+------------+
| Activate Module | |
+-------------------+------------+
| Deactivate Module | |
+-------------------+------------+
| Activate Payload | |
+-------------------+------------+
| Deactivate Payload| |
+-------------------+------------+
| Erase Memory | |
+-------------------+------------+
| Force Reset | |
+-------------------+------------+
| Get Payload Data | |
+-------------------+------------+
| Set Parameter | |
+-------------------+------------+
| Get Parameter | |
+-------------------+------------+

References
==========
Expand Down
13 changes: 7 additions & 6 deletions docs/logfile.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
##############
**************
Logging System
##############
**************

The Logging System of the Spacelab Transmitter shows the events performed in the software - such as when a telecommand was executed - 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_transmitter", but in the preferences of the software the user can choose in which folder to save the file.

The logfile is automatically generated inside a default folder in the user home page in the archives called "spacelab_transmitter". It is a .csv file displaying date and time on one column and the event on the other one.
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 transmission, an error or even the software startup.

Future updating includes an option to choose the file folder.

25 changes: 20 additions & 5 deletions docs/telecommands_transmissions.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
************************
Telecommand Transmission
************************
*************************
Telecommands Transmission
*************************

Introduction
============

In order to not depend on another software to transmit telecommands, it was implemented a GMSK modulator in the code so that the Spacelab Transmitter works alone with the SDR.
The Spacelab-Transmitter is the software for the Spacelab's Ground Station (GRS), it can transmit 14 telecommands as previously shown in the overview.

In order to not depend on another software to transmit telecommands, it was implemented a GMSK modulator in the code so that the Spacelab Transmitter works alone with the Software-Defined Radio.

The default Software-Defined Radio used in Spacelab is the USRP210 so the code was written based in the integration with this specific SDR.

.. image:: img/usrp.png
:width: 500

GMSK Implementation
====================
===================



Integration with USRP SDR
=========================


References
==========
https://github.com/skagmo/ngham

https://github.com/mgm8/pyngham

https://pysdr.org/content/usrp.html

Viswanathan, Mathuranathan. Digital Modulations Using Python. 1st ed., vol. 1, Independently published, 2019.

0 comments on commit a5268a3

Please sign in to comment.