Merge pull request #16 from spacefisch/develop

Gathering changes for 1.6.0

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.8
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+           - gui

README.md

@@ -15,16 +15,14 @@ This commander application was first developed by KSat for the
 software but has evolved into a more generic tool for satellite developers to perform TMTC 
 (Telemetry and Telecommand) handling and testing via different communication interfaces. 
 Currently, only the PUS standard is implemented as a packet standard. This tool can be used either 
-as a command line tool or as a GUI tool, but the GUI capabilities are still in an alpha state.
+as a command line tool or as a GUI tool. The GUI features require a PyQt5 installation.
 
 This client currently supports the following communication interfaces:
 
-1. TCP/IP with UDP packets
+1. TCP/IP with UDP and TCP
 2. Serial Communication using fixed frames or a simple ASCII based transport layer
 3. QEMU, using a virtual serial interface
 
-A TCP implementation is planned.
-
 The TMTC commander also includes a Space Packet and a ECSS PUS packet stack. Some of these
 components might be moved to an own library soon, so they were decoupled from the rest 
 of the TMTC commander components.
@@ -96,4 +94,4 @@ python3 -m pip install -e .[gui]
 ```
 
 Omit the `-e` for a regular installation. Alternatively you can now install the package
-from PyPI with `python3 -m pip install -e tmtccmd`.
+from PyPI with `python3 -m pip install -e tmtccmd[gui]`.

docs/api.rst

@@ -1,3 +1,49 @@
 ====
 API
-====
+====
+
+Core Submodules
+===============
+
+tmtccmd.runner module
+---------------------
+
+.. automodule:: tmtccmd.runner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+
+   api/tmtccmd.core
+   api/tmtccmd.sendreceive
+
+Configuration Submodules
+=========================
+
+.. toctree::
+   :maxdepth: 4
+
+   api/tmtccmd.config
+   api/tmtccmd.com_if
+
+ECSS & PUS Submodules
+=========================
+
+.. toctree::
+   :maxdepth: 4
+
+   api/tmtccmd.ccsds
+   api/tmtccmd.ecss
+   api/tmtccmd.pus
+   api/tmtccmd.pus_tc
+   api/tmtccmd.pus_tm
+
+Other Submodules
+=========================
+
+.. toctree::
+   :maxdepth: 4
+
+   api/tmtccmd.utility

docs/api/tmtccmd.ccsds.rst

@@ -0,0 +1,29 @@
+tmtccmd.ccsds package
+=====================
+
+Submodules
+----------
+
+tmtccmd.ccsds.cfdp module
+-------------------------
+
+.. automodule:: tmtccmd.ccsds.cfdp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.ccsds.spacepacket module
+--------------------------------
+
+.. automodule:: tmtccmd.ccsds.spacepacket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tmtccmd.ccsds
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/tmtccmd.com_if.rst

@@ -0,0 +1,85 @@
+tmtccmd.com\_if package
+=======================
+
+Submodules
+----------
+
+tmtccmd.com\_if.com\_if\_utilities module
+-----------------------------------------
+
+.. automodule:: tmtccmd.com_if.com_if_utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.com\_interface\_base module
+-------------------------------------------
+
+.. automodule:: tmtccmd.com_if.com_interface_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.dummy\_com\_if module
+-------------------------------------
+
+.. automodule:: tmtccmd.com_if.dummy_com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.qemu\_com\_if module
+------------------------------------
+
+.. automodule:: tmtccmd.com_if.qemu_com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.serial\_com\_if module
+--------------------------------------
+
+.. automodule:: tmtccmd.com_if.serial_com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.serial\_utilities module
+----------------------------------------
+
+.. automodule:: tmtccmd.com_if.serial_utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.tcpip\_tcp\_com\_if module
+------------------------------------------
+
+.. automodule:: tmtccmd.com_if.tcpip_tcp_com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.tcpip\_udp\_com\_if module
+------------------------------------------
+
+.. automodule:: tmtccmd.com_if.tcpip_udp_com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.com\_if.tcpip\_utilities module
+---------------------------------------
+
+.. automodule:: tmtccmd.com_if.tcpip_utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tmtccmd.com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/tmtccmd.config.rst

@@ -0,0 +1,61 @@
+tmtccmd.config package
+======================
+
+Submodules
+----------
+
+tmtccmd.config.hook module
+--------------------------
+
+.. automodule:: tmtccmd.config.hook
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.config.args module
+--------------------------
+
+.. automodule:: tmtccmd.config.args
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.config.com\_if module
+-----------------------------
+
+.. automodule:: tmtccmd.config.com_if
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.config.definitions module
+---------------------------------
+
+.. automodule:: tmtccmd.config.definitions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.config.globals module
+-----------------------------
+
+.. automodule:: tmtccmd.config.globals
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.config.objects module
+-----------------------------
+
+.. automodule:: tmtccmd.config.objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tmtccmd.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/tmtccmd.core.rst

@@ -0,0 +1,53 @@
+tmtccmd.core package
+====================
+
+Submodules
+----------
+
+tmtccmd.core.backend module
+---------------------------
+
+.. automodule:: tmtccmd.core.backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.core.frontend module
+----------------------------
+
+.. automodule:: tmtccmd.core.frontend
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.core.frontend\_base module
+----------------------------------
+
+.. automodule:: tmtccmd.core.frontend_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.core.globals\_manager module
+------------------------------------
+
+.. automodule:: tmtccmd.core.globals_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.core.object\_id\_manager module
+---------------------------------------
+
+.. automodule:: tmtccmd.core.object_id_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tmtccmd.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/tmtccmd.ecss.rst

@@ -0,0 +1,45 @@
+tmtccmd.ecss package
+====================
+
+Submodules
+----------
+
+tmtccmd.ecss.conf module
+------------------------
+
+.. automodule:: tmtccmd.ecss.conf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.ecss.tc module
+----------------------
+
+.. automodule:: tmtccmd.ecss.tc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.ecss.tm module
+----------------------
+
+.. automodule:: tmtccmd.ecss.tm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tmtccmd.ecss.tm\_creator module
+-------------------------------
+
+.. automodule:: tmtccmd.ecss.tm_creator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tmtccmd.ecss
+   :members:
+   :undoc-members:
+   :show-inheritance: