Robin Mueller
0fd70c08c2
All checks were successful
Rust/sat-rs/pipeline/pr-main This commit looks good
- Increased example modularization by moving the majority of app logic inside dedicated modules - Added a new `dyn_tmtc` feature for the satrs-example which is used to configure the heap as the backing store for TMTC packages instead of static stores. - Added dedicated satrs-example chapter in satrs-book
75 lines
2.5 KiB
Markdown
75 lines
2.5 KiB
Markdown
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](https://absatsw.irs.uni-stuttgart.de/projects/sat-rs/book/example.html) 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`.
|
|
|
|
# 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
|
|
|
|
```sh
|
|
cargo run --no-default-features
|
|
```
|
|
|
|
# Interacting with the sat-rs example
|
|
|
|
## Simple Client
|
|
|
|
The `simpleclient` binary target sends a
|
|
ping telecommand and then verifies the telemetry generated by the example application.
|
|
It can be run like this:
|
|
|
|
```rs
|
|
cargo run --bin simpleclient
|
|
```
|
|
|
|
This repository also contains a more complex client using the
|
|
[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module.
|
|
|
|
## <a id="tmtccmd"></a> Using the tmtccmd Python client
|
|
|
|
The python client requires a valid installation of the
|
|
[tmtccmd package](https://github.com/robamu-org/tmtccmd).
|
|
|
|
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](https://docs.python.org/3/tutorial/venv.html)
|
|
on how to activate the environment and then use the following command to install the required
|
|
dependency:
|
|
|
|
```sh
|
|
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
|
|
|
|
```sh
|
|
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`:
|
|
|
|
```sh
|
|
./main.py -p /test/ping
|
|
```
|
|
|
|
You can also simply call the script without any arguments to view the command tree.
|