From 0424db936567aac993eda5bb0bda1de8e69d8fa7 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Sun, 20 Nov 2022 20:42:29 +0100
Subject: [PATCH] basic README for example

---
 .idea/runConfigurations/Run_obsw_example.xml  |  2 +-
 ...example.xml => Run_obsw_simple_client.xml} |  2 +-
 satrs-example/Cargo.toml                      |  1 +
 satrs-example/README.md                       | 42 ++++++++++++++++++-
 satrs-example/pyclient/.gitignore             |  2 +
 satrs-example/pyclient/seqcnt.txt             |  1 -
 .../src/bin/{client.rs => simpleclient.rs}    |  0
 7 files changed, 46 insertions(+), 4 deletions(-)
 rename .idea/runConfigurations/{Run_obsw_client_example.xml => Run_obsw_simple_client.xml} (84%)
 delete mode 100644 satrs-example/pyclient/seqcnt.txt
 rename satrs-example/src/bin/{client.rs => simpleclient.rs} (100%)

diff --git a/.idea/runConfigurations/Run_obsw_example.xml b/.idea/runConfigurations/Run_obsw_example.xml
index ed323c9..df610ba 100644
--- a/.idea/runConfigurations/Run_obsw_example.xml
+++ b/.idea/runConfigurations/Run_obsw_example.xml
@@ -1,6 +1,6 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run obsw example" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
-    <option name="command" value="run --package fsrc-example --bin obsw" />
+    <option name="command" value="run -p satrs-example --bin satrs-example" />
     <option name="workingDirectory" value="file://$PROJECT_DIR$" />
     <option name="channel" value="DEFAULT" />
     <option name="requiredFeatures" value="true" />
diff --git a/.idea/runConfigurations/Run_obsw_client_example.xml b/.idea/runConfigurations/Run_obsw_simple_client.xml
similarity index 84%
rename from .idea/runConfigurations/Run_obsw_client_example.xml
rename to .idea/runConfigurations/Run_obsw_simple_client.xml
index dc85ad6..4679680 100644
--- a/.idea/runConfigurations/Run_obsw_client_example.xml
+++ b/.idea/runConfigurations/Run_obsw_simple_client.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run obsw client example" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
+  <configuration default="false" name="Run obsw simple client" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
     <option name="command" value="run --package fsrc-example --bin client" />
     <option name="workingDirectory" value="file://$PROJECT_DIR$" />
     <option name="channel" value="DEFAULT" />
diff --git a/satrs-example/Cargo.toml b/satrs-example/Cargo.toml
index 4c6eae7..2542451 100644
--- a/satrs-example/Cargo.toml
+++ b/satrs-example/Cargo.toml
@@ -3,6 +3,7 @@ name = "satrs-example"
 version = "0.1.0"
 edition = "2021"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
+default-run = "satrs-example"
 
 [dependencies]
 crossbeam-channel = "0.5"
diff --git a/satrs-example/README.md b/satrs-example/README.md
index 1318fc5..e477829 100644
--- a/satrs-example/README.md
+++ b/satrs-example/README.md
@@ -1,5 +1,45 @@
 sat-rs example
 ======
 
-# Installing the OBSW client
+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.
 
+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:
+
+```rs
+cargo run --bin simpleclient
+```
+
+This repository also contains a more complex client using the
+[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module.
+
+# 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.
diff --git a/satrs-example/pyclient/.gitignore b/satrs-example/pyclient/.gitignore
index 13485ba..fa91f52 100644
--- a/satrs-example/pyclient/.gitignore
+++ b/satrs-example/pyclient/.gitignore
@@ -2,3 +2,5 @@
 /log
 /.idea/*
 !/.idea/runConfigurations
+
+/seqcnt.txt
diff --git a/satrs-example/pyclient/seqcnt.txt b/satrs-example/pyclient/seqcnt.txt
deleted file mode 100644
index 64bb6b7..0000000
--- a/satrs-example/pyclient/seqcnt.txt
+++ /dev/null
@@ -1 +0,0 @@
-30
diff --git a/satrs-example/src/bin/client.rs b/satrs-example/src/bin/simpleclient.rs
similarity index 100%
rename from satrs-example/src/bin/client.rs
rename to satrs-example/src/bin/simpleclient.rs