sat-rs/satrs-example/README.md

sat-rs example

This crate contains an example application which simulates an on-board software. It uses various components provided by the sat-rs framework to do this. As such, it shows how a more complex real on-board software could be built from these components. It is recommended to read the dedicated example chapters inside the sat-rs book.

The application opens a UDP and a TCP server on port 7301 to receive telecommands.

You can run the application using cargo run. The simpleclient binary target sends a ping telecommand and then verifies the telemetry generated by the example application. It can be run like this:

cargo run --bin simpleclient

This repository also contains a more complex client using the Python tmtccmd module.

Features

The example has the dyn_tmtc feature which is enabled by default. With this feature enabled, TMTC packets are exchanged using the heap as the backing memory instead of pre-allocated static stores.

You can run the application without this feature using

cargo run --no-default-features

Using the tmtccmd Python client

The python client requires a valid installation of the tmtccmd package.

It is recommended to use a virtual environment to do this. To set up one in the command line, you can use python3 -m venv venv on Unix systems or py -m venv venv on Windows systems. After doing this, you can check the venv tutorial on how to activate the environment and then use the following command to install the required dependency:

pip install -r requirements.txt

Alternatively, if you would like to use the GUI functionality provided by tmtccmd, you can also install it manually with

pip install tmtccmd[gui]

After setting up the dependencies, you can simply run the main.py script to send commands to the OBSW example and to view and handle incoming telemetry. The script and the tmtccmd framework it uses allow to easily add and expose additional telecommand and telemetry handling as Python code. For example, you can use the following command to send a ping like done with the simpleclient:

./main.py -p /test/ping

You can also simply call the script without any arguments to view the command tree.

High-level information about the example project

You can read more high-level information inside the dedicated chapter of the sat-rs book.