diff --git a/satrs-example/README.md b/satrs-example/README.md index faed14e..c78c08f 100644 --- a/satrs-example/README.md +++ b/satrs-example/README.md @@ -3,8 +3,12 @@ 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. -The application opens a UDP server on port 7301 to receive telecommands. +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`. The `simpleclient` binary target sends a 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 [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 +``` + # Using the tmtccmd Python client The python client requires a valid installation of the