rust/sat-rs
rust/sat-rs
6
1
Fork 0
Code Issues 9 Pull Requests Projects Releases 23 Wiki Activity

README update
All checks were successful
Rust/sat-rs/pipeline/pr-main This commit looks good
Details

Browse Source
This commit is contained in:
Robin Müller 2024-02-07 18:07:21 +01:00
parent b46f4ac875
commit f0073432ff
Signed by: muellerr
GPG Key ID: A649FB78196E3849
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
satrs-example/README.md
View File

@ -3,8 +3,12 @@ sat-rs example
This crate contains an example application which simulates an on-board software. 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 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. a more complex real on-board software could be built from these components. It is recommended to
The application opens a UDP server on port 7301 to receive telecommands. 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`. The `simpleclient` binary target sends a 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. ping telecommand and then verifies the telemetry generated by the example application.
@ -17,6 +21,18 @@ cargo run --bin simpleclient
This repository also contains a more complex client using the This repository also contains a more complex client using the
[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module. [Python tmtccmd](https://github.com/robamu-org/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
```sh
cargo run --no-default-features
```
# <a id="tmtccmd"></a> Using the tmtccmd Python client # <a id="tmtccmd"></a> Using the tmtccmd Python client
The python client requires a valid installation of the The python client requires a valid installation of the