diff --git a/core/tmtc_client_core.py b/core/tmtc_client_core.py index 88846e9e92af1e4f06326eae3fb6ed8cecad7448..bbf060f1ec6757a360a5af938fd3aa3b9afdf687 100755 --- a/core/tmtc_client_core.py +++ b/core/tmtc_client_core.py @@ -1,29 +1,9 @@ #!/usr/bin/python3 """ -@brief This client was developed by KSat for the SOURCE project to test the on-board software. +@brief Core method called by entry point files to initiate the TMTC commander @details -This client features multiple sender/receiver modes and has been designed -to be extensible and easy to use. This clien is based on the PUS standard for the format -of telecommands and telemetry. It can also send TMTC via different interfaces like the -serial interface (USB port) or ethernet interface. - -@license -Copyright 2020 KSat e.V. Stuttgart - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - @manual -Run this file with the -h flag to display options. +@author R. Mueller """ import sys diff --git a/tmtc_client_cli.py b/tmtc_client_cli.py index 89a10ee3d4a7c7b8f850083d82bbc66582ee15fd..d71242ba9731f4e7154312ed5d3da9a3085b9d92 100644 --- a/tmtc_client_cli.py +++ b/tmtc_client_cli.py @@ -1,11 +1,13 @@ #!/usr/bin/python3 """ -@brief This client was developed by KSat for the SOURCE project to test the on-board software. +@brief TMTC Commander entry point for command line mode. @details -This client features multiple sender/receiver modes and has been designed -to be extensible and easy to use. This clien is based on the PUS standard for the format -of telecommands and telemetry. It can also send TMTC via different interfaces like the -serial interface (USB port) or ethernet interface. +This client was developed by KSat for the SOURCE project to test the on-board software but +has become a more generic tool to perform TMTC (Telemetry and Telecommand) handling via +different communication interfacec. Currently, only the PUS standard is implemented as a packet +standard. + +Run this file with the -h flag to display options. @license Copyright 2020 KSat e.V. Stuttgart @@ -22,8 +24,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -@manual -Run this file with the -h flag to display options. +@author R. Mueller """ from core.tmtc_client_core import run_tmtc_client diff --git a/tmtc_client_gui.py b/tmtc_client_gui.py index 0e1cab1f23558fcd7e79da7556cff4f97c679c9c..5d2b26ea7d115dc09292f94407c0b848906e71f4 100644 --- a/tmtc_client_gui.py +++ b/tmtc_client_gui.py @@ -1,11 +1,13 @@ #!/usr/bin/python3 """ -@brief This client was developed by KSat for the SOURCE project to test the on-board software. +@brief TMTC Commander entry point for GUI mode. @details -This client features multiple sender/receiver modes and has been designed -to be extensible and easy to use. This clien is based on the PUS standard for the format -of telecommands and telemetry. It can also send TMTC via different interfaces like the -serial interface (USB port) or ethernet interface. +This client was developed by KSat for the SOURCE project to test the on-board software but +has become a more generic tool to perform TMTC (Telemetry and Telecommand) handling via +different communication interfacec. Currently, only the PUS standard is implemented as a packet +standard. + +Run this file with the -h flag to display options. @license Copyright 2020 KSat e.V. Stuttgart @@ -22,7 +24,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -@manual +@author R. Mueller """ from core.tmtc_client_core import run_tmtc_client