diff --git a/README.md b/README.md index 34a8e69..ae2cbf8 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,42 @@ cross build ```sh cross build --release ``` + +## Commanding Infrastructure + +Commanding of the `ops-sat-rs` application is possible by different means. + +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 command the TCP server in the OPS-SAT software directly by running the commands with +the following configuration: + +```json +{ + "com_if": "tcp", + "tcpip_tcp_ip_addr": "127.0.0.1", + "tcpip_tcp_port": 7031 +} +``` + +You can run `pyclient.py -T` or `pyclient.py -h` for more information on the client application. diff --git a/docs/networking-structure.graphml b/docs/networking-structure.graphml new file mode 100644 index 0000000..1c85eef --- /dev/null +++ b/docs/networking-structure.graphml @@ -0,0 +1,193 @@ + + + + + + + + + + + + + + + + + + + + + + + + ops-sat-rs on satellite + + + + + + + + + + + + TCP SPP +Client + + + + + + + + + + + + pyserver +daemon + + + + + + + + + + + + OPS-SAT +Server +Port 4096 + + + + + + + + + + + + TMTC +Server +Port 4097 + + + + + + + + + + + + pyclient + + + + + + + + + + + + TCP +Server +Port 7301 + + + + + + + + + + + + UDP +Server +Port 7301 + + + + + + + + + + + + TMTC +Queue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/networking-structure.png b/docs/networking-structure.png new file mode 100644 index 0000000..06c2c70 Binary files /dev/null and b/docs/networking-structure.png differ