From 0573d81e577d582ac52501a2ac719ecec205f352 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Fri, 19 Apr 2024 18:09:52 +0200 Subject: [PATCH] docs --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 79ad2a9..eb34f5d 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,26 @@ cross build --release Commanding of the `ops-sat-rs` application is possible by different means. -![Networking and Commanding Structure](docs/networking-structure.png "Networking and Commanding Structure") +Networking and Commanding Structure ### Using the `pyclient` and `pyserver` applications + +You can find both commanding application inside the `pytmtc` folder. +You can also find a `requirements.txt` file there to install all required Python dependencies. + +If you want to command the satellite using the OPS-SAT infrastrucute, start the `pyserver.py` +as a background application first, for example by simply running `pyserver.py` inside a +new terminal window. + +After that, you can run `pyclient.py -p /test/ping -l` to send a ping telecommand and then +go into listener mode using the following `tmtc_conf.json` file: + +```json +{ + "com_if": "tcp", + "tcpip_tcp_ip_addr": "127.0.0.1", + "tcpip_tcp_port": 4097 +} +``` + +You can run `pyclient.py -T` or `pyclient.py -h` for more information on the client application.