update tmtc doc and add requirements.txt
All checks were successful
fsfw/fsfw example hosted/pipeline/head This commit looks good

This commit is contained in:
Robin Müller 2021-12-14 18:16:00 +01:00
parent 307df75a4d
commit 1bc4424453
No known key found for this signature in database
GPG Key ID: BE6480244DFE612C
3 changed files with 25 additions and 2 deletions

View File

@ -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
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
## 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
For a quick test, install the `tmtccmd` Python package first and use `py` instead
of `python3` on Windows:
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.
## <a id="prereqsetup"></a> 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 <Exe>` in the
Windows command line

tmtc/requirements.txt Normal file
View File

@ -0,0 +1 @@
tmtccmd == 1.10.1

@ -1 +1 @@
Subproject commit b4ed174ff47d0ed5fb24b8d9ba301e12a470fd2b
Subproject commit 1c3c9c44e563be510feed4600cabaa6bdc88649a