From 1bc4424453576417a60b85ad32d208128c2b1ba5 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 14 Dec 2021 18:16:00 +0100 Subject: [PATCH] update tmtc doc and add requirements.txt --- README.md | 24 +++++++++++++++++++++++- tmtc/requirements.txt | 1 + tmtc/tmtccmd | 2 +- 3 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 tmtc/requirements.txt diff --git a/README.md b/README.md index 5cbc1b0..4927524 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,12 @@ the host abstraction layer of the FSFW. This demo provides the opportunity to to test functionality of the FSFW on a host computer without the need of setting up external embedded hardware. + ## Prerequisites +If you need to set up these prerequisites, you can find some more information in the dedicated +[chapter](#prereqsetup). + 1. Makefile build: make installed (bundled with MSYS2 on Windows or via [xPacks Windows Build Tools](https://xpack.github.io/windows-build-tools/install/)). Natively installed on Linux. 2. Recommended for application code development: [Eclipse for C/C++](https://www.eclipse.org/downloads/packages/) . Project files and launch configuration are provided for Eclipse to ease development. @@ -62,6 +66,25 @@ FSFW on a host computer without the need of setting up external embedded hardwar 4. Recommended: Python 3 and [just](https://github.com/casey/just) installed for easy build generation +## Commanding the Software + +When the software is running, it opens a TCP oder UDP server, depending on the configuration, +on port 7301. You can send PUS telecommands to that port to interactively command the +software. + +For a quick test, install the `tmtccmd` Python package first and use `py` instead +of `python3` on Windows: + +```sh +cd tmtccmd +python3 -m pip install -r requirements.txt +``` + +Now you can command the software using the `tmtccli.py` and `tmtcgui.py` command. +For example, you can use `tmtccli.py -s 17 -o 0` to send a ping command. + +## Setting up Prerequisites + ### Windows - MinGW64 build 1. [MSYS2 and MinGW64](https://www.msys2.org/) installed @@ -207,4 +230,3 @@ The debug output is colored by default. It is recommended to install the it is recommended to run the applicaton with the Windows command line for the printout to work properly. You can do this by simply double-clicking the binary or using `start ` in the Windows command line - diff --git a/tmtc/requirements.txt b/tmtc/requirements.txt new file mode 100644 index 0000000..e9ef9ef --- /dev/null +++ b/tmtc/requirements.txt @@ -0,0 +1 @@ +tmtccmd == 1.10.1 diff --git a/tmtc/tmtccmd b/tmtc/tmtccmd index b4ed174..1c3c9c4 160000 --- a/tmtc/tmtccmd +++ b/tmtc/tmtccmd @@ -1 +1 @@ -Subproject commit b4ed174ff47d0ed5fb24b8d9ba301e12a470fd2b +Subproject commit 1c3c9c44e563be510feed4600cabaa6bdc88649a