first step in unifying the examples: one example folder

One example folder for all examples, including std and embedded examples

Cargo.toml

@@ -3,17 +3,17 @@ resolver = "2"
 members = [
     "satrs",
     "satrs-mib",
-    "satrs-example",
-    "satrs-example/types",
-    "satrs-example/client",
-    "satrs-example/minisim",
+    "examples/obsw-std",
+    "examples/types",
+    "examples/client",
+    "examples/minisim",
     "satrs-shared",
     "tmtc-utils",
-    "embedded-examples/embedded-client",
-    "embedded-examples/types",
+    "examples/embedded-client",
+    "examples/embedded-types",
 ]
 
 exclude = [
-    "embedded-examples/stm32f3-disco-rtic",
-    "embedded-examples/stm32h7-nucleo-rtic",
+    "examples/stm32f3-disco-rtic",
+    "examples/stm32h7-nucleo-rtic",
 ]

README.md

@@ -34,19 +34,19 @@ This project currently contains following crates:
    this first before delving into the example application and the API documentation.
 * [`satrs`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs):
    Primary crate.
-* [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example):
+* [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std):
    Example of a simple example on-board software using various sat-rs components which can be run
    on a host computer or on any system with a standard runtime like a Raspberry Pi.
-* [`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-minisim):
+* [`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/minisim):
    Mini-Simulator based on [nexosim](https://github.com/asynchronics/nexosim) which
    simulates some physical devices for the `satrs-example` application device handlers.
 * [`satrs-mib`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-mib):
    Components to build a mission information base from the on-board software directly.
-* [`satrs-stm32f3-disco-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-examples/stm32f3-disco-rtic):
+* [`satrs-stm32f3-disco-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/stm32f3-disco-rtic):
    Example of a simple example using low-level sat-rs components on a bare-metal system
    with constrained resources. This example uses the [RTIC](https://github.com/rtic-rs/rtic)
    framework on the STM32F3-Discovery device.
-* [`satrs-stm32h-nucleo-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-examples/stm32h7-nucleo-rtic):
+* [`satrs-stm32h-nucleo-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/stm32h7-nucleo-rtic):
    Example of a simple example using sat-rs components on a bare-metal system
    with constrained resources. This example uses the [RTIC](https://github.com/rtic-rs/rtic)
    framework on the STM32H743ZIT device.

examples/client/Cargo.toml

@@ -11,7 +11,7 @@ humantime = "2"
 serde = { version = "1" }
 serde_json = "1"
 satrs = { path = "../../satrs" }
-satrs-example = { path = ".." }
+satrs-example = { path = "../obsw-std" }
 satrs-minisim = { path = "../minisim" }
 types = { path = "../types" }
 spacepackets = { version = "0.18", default-features = false }

examples/embedded-client/Cargo.toml

@@ -9,7 +9,7 @@ serialport = "4"
 toml = "0.9"
 serde = { version = "1", features = ["derive"] }
 spacepackets = { version = "0.18" }
-embedded-types = { path = "../types" }
+embedded-types = { path = "../embedded-types" }
 tmtc-utils = { path = "../../tmtc-utils" }
 postcard = { version = "1", features = ["alloc"] }
 anyhow = "1"

examples/minisim/README.md

@@ -5,7 +5,7 @@ This crate contains a mini-simulator based on the open-source discrete-event sim
 [nexosim](https://github.com/asynchronics/nexosim).
 
 Right now, this crate is primarily used together with the
-[`satrs-example` application](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example)
+[`satrs-example` application](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std)
 to simulate the devices connected to the example application.
 
 You can simply run this application using

examples/obsw-std/Cargo.toml

@@ -27,10 +27,10 @@ ctrlc = "3"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
-satrs = { path = "../satrs", features = ["test_util"] }
-types = { path = "./types" }
-satrs-minisim = { path = "./minisim" }
-satrs-mib = { path = "../satrs-mib" }
+satrs = { path = "../../satrs", features = ["test_util"] }
+types = { path = "../types" }
+satrs-minisim = { path = "../minisim" }
+satrs-mib = { path = "../../satrs-mib" }
 
 [features]
 # default = ["heap_tmtc"]

examples/obsw-std/README.md

@@ -40,7 +40,7 @@ Use `cargo run -p client -- --help` to list all available commands.
 ## Adding the mini simulator application
 
 This example application features a few device handlers. The
-[`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/minisim)
+[`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/minisim)
 can be used to simulate the physical devices managed by these device handlers.
 
 The example application will attempt communication with the mini simulator on UDP port 7303.

examples/stm32f3-disco-rtic/Cargo.toml

@@ -7,7 +7,7 @@ default-run = "satrs-stm32f3-disco-rtic"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-embedded-types = { path = "../types", features = ["defmt"] }
+embedded-types = { path = "../embedded-types", features = ["defmt"] }
 cortex-m = { version = "0.7", features = ["critical-section-single-core"] }
 cortex-m-rt = "0.7"
 defmt = "1"

examples/stm32h7-nucleo-rtic/Cargo.toml

@@ -13,7 +13,7 @@ name = "integration"
 harness = false
 
 [dependencies]
-embedded-types = { path = "../types", features = ["defmt"] }
+embedded-types = { path = "../embedded-types", features = ["defmt"] }
 
 cortex-m = { version = "0.7", features = ["critical-section-single-core"] }
 arbitrary-int = "2"