From 2ba0ace38872912d6b291afc5b61463a7b5a8948 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 24 Sep 2026 19:45:02 +0200 Subject: [PATCH] first step in unifying the examples: one example folder One example folder for all examples, including std and embedded examples --- Cargo.toml | 16 ++++++++-------- README.md | 8 ++++---- {satrs-example => examples}/client/Cargo.toml | 2 +- {satrs-example => examples}/client/src/main.rs | 0 .../embedded-client/Cargo.toml | 2 +- .../embedded-client/config.toml | 0 .../embedded-client/src/bin/stm32f3-client.rs | 0 .../embedded-client/src/bin/stm32h7-client.rs | 0 .../embedded-client/src/lib.rs | 0 .../embedded-types}/Cargo.toml | 0 .../embedded-types}/src/lib.rs | 0 {satrs-example => examples}/minisim/Cargo.toml | 0 {satrs-example => examples}/minisim/README.md | 2 +- .../minisim/src/acs/mgm.rs | 0 .../minisim/src/acs/mgt.rs | 0 .../minisim/src/acs/mod.rs | 0 .../minisim/src/controller.rs | 0 {satrs-example => examples}/minisim/src/eps.rs | 0 {satrs-example => examples}/minisim/src/lib.rs | 0 {satrs-example => examples}/minisim/src/main.rs | 0 .../minisim/src/test_helpers.rs | 0 {satrs-example => examples}/minisim/src/time.rs | 0 {satrs-example => examples}/minisim/src/udp.rs | 0 {satrs-example => examples/obsw-std}/.gitignore | 0 .../obsw-std}/CHANGELOG.md | 0 {satrs-example => examples/obsw-std}/Cargo.toml | 8 ++++---- .../obsw-std}/LICENSE-APACHE | 0 .../obsw-std}/NOTICE | 0 {satrs-example => examples/obsw-std}/README.md | 2 +- .../obsw-std}/src/acs/ctrl.rs | 0 .../obsw-std}/src/acs/mgm.rs | 0 .../obsw-std}/src/acs/mgm_assembly.rs | 0 .../obsw-std}/src/acs/mgt.rs | 0 .../obsw-std}/src/acs/mod.rs | 0 .../obsw-std}/src/acs/subsystem.rs | 0 .../obsw-std}/src/ccsds.rs | 0 .../obsw-std}/src/config.rs | 0 .../obsw-std}/src/controller.rs | 0 .../obsw-std}/src/device_mode.rs | 0 .../obsw-std}/src/eps/mod.rs | 0 .../obsw-std}/src/eps/pcdu.rs | 0 .../obsw-std}/src/event_manager.rs | 0 .../obsw-std}/src/interface/mod.rs | 0 .../obsw-std}/src/interface/sim_client_udp.rs | 0 .../obsw-std}/src/interface/tcp.rs | 0 .../obsw-std}/src/interface/udp.rs | 0 .../obsw-std}/src/legacy/events.rs | 0 .../obsw-std}/src/legacy/hk.rs | 0 .../obsw-std}/src/legacy/pus/action.rs | 0 .../obsw-std}/src/legacy/pus/event.rs | 0 .../obsw-std}/src/legacy/pus/hk.rs | 0 .../obsw-std}/src/legacy/pus/mod.rs | 0 .../obsw-std}/src/legacy/pus/mode.rs | 0 .../obsw-std}/src/legacy/pus/scheduler.rs | 0 .../obsw-std}/src/legacy/pus/stack.rs | 0 .../obsw-std}/src/legacy/pus/test.rs | 0 .../obsw-std}/src/legacy/requests.rs | 0 {satrs-example => examples/obsw-std}/src/lib.rs | 0 .../obsw-std}/src/logger.rs | 0 .../obsw-std}/src/main.rs | 0 .../obsw-std}/src/tmtc/mod.rs | 0 .../obsw-std}/src/tmtc/sender.rs | 0 .../obsw-std}/src/tmtc/tc_source.rs | 0 .../obsw-std}/src/tmtc/tm_sink.rs | 0 .../.cargo/config.toml.template | 0 .../stm32f3-disco-rtic/.gitignore | 0 .../stm32f3-disco-rtic/Cargo.lock | 0 .../stm32f3-disco-rtic/Cargo.toml | 2 +- .../stm32f3-disco-rtic}/LICENSE-APACHE | 0 .../stm32f3-disco-rtic}/NOTICE | 0 .../stm32f3-disco-rtic/README.md | 0 .../stm32f3-disco-rtic/src/bin/blinky.rs | 0 .../stm32f3-disco-rtic/src/lib.rs | 0 .../stm32f3-disco-rtic/src/main.rs | 0 .../stm32f3-disco-rtic/vscode/.gitignore | 0 .../stm32f3-disco-rtic/vscode/extensions.json | 0 .../stm32f3-disco-rtic/vscode/launch.json | 0 .../vscode/openocd-helpers.tcl | 0 .../stm32f3-disco-rtic/vscode/tasks.json | 0 .../.cargo/config.toml.template | 0 .../stm32h7-nucleo-rtic/.gitignore | 0 .../stm32h7-nucleo-rtic/Cargo.lock | 0 .../stm32h7-nucleo-rtic/Cargo.toml | 2 +- .../stm32h7-nucleo-rtic}/LICENSE-APACHE | 0 .../stm32h7-nucleo-rtic/README.md | 0 .../stm32h7-nucleo-rtic/build.rs | 0 ...cleo144-boards-mb1364-stmicroelectronics.pdf | Bin .../stm32h7-nucleo-rtic/memory.x.tmp | 0 .../stm32h7-nucleo-rtic/rust-toolchain.toml | 0 .../stm32h7-nucleo-rtic/src/bin/blinky.rs | 0 .../stm32h7-nucleo-rtic/src/bin/hello.rs | 0 .../stm32h7-nucleo-rtic/src/lib.rs | 0 .../stm32h7-nucleo-rtic/src/main.rs | 0 .../stm32h7-nucleo-rtic/tests/integration.rs | 0 {satrs-example => examples}/types/Cargo.toml | 0 .../types/src/acs/ctrl.rs | 0 .../types/src/acs/mgm.rs | 0 .../types/src/acs/mgm_assembly.rs | 0 .../types/src/acs/mgt.rs | 0 .../types/src/acs/mod.rs | 0 .../types/src/acs/subsystem.rs | 0 {satrs-example => examples}/types/src/ccsds.rs | 0 .../types/src/control.rs | 0 .../types/src/event_manager.rs | 0 {satrs-example => examples}/types/src/lib.rs | 0 {satrs-example => examples}/types/src/pcdu.rs | 0 {satrs-example => examples}/types/src/tmtc.rs | 0 .../types/tests/ccsds_len.rs | 0 experiments/satrs-gen/src/main.rs | 2 +- justfile | 4 ++-- satrs-book/src/example.md | 2 +- satrs-book/src/introduction.md | 4 ++-- satrs/src/hal/std/udp_server.rs | 4 ++-- satrs/src/legacy/event_man.rs | 6 +++--- satrs/src/legacy/event_man_legacy.rs | 6 +++--- 115 files changed, 36 insertions(+), 36 deletions(-) rename {satrs-example => examples}/client/Cargo.toml (92%) rename {satrs-example => examples}/client/src/main.rs (100%) rename {embedded-examples => examples}/embedded-client/Cargo.toml (89%) rename {embedded-examples => examples}/embedded-client/config.toml (100%) rename {embedded-examples => examples}/embedded-client/src/bin/stm32f3-client.rs (100%) rename {embedded-examples => examples}/embedded-client/src/bin/stm32h7-client.rs (100%) rename {embedded-examples => examples}/embedded-client/src/lib.rs (100%) rename {embedded-examples/types => examples/embedded-types}/Cargo.toml (100%) rename {embedded-examples/types => examples/embedded-types}/src/lib.rs (100%) rename {satrs-example => examples}/minisim/Cargo.toml (100%) rename {satrs-example => examples}/minisim/README.md (95%) rename {satrs-example => examples}/minisim/src/acs/mgm.rs (100%) rename {satrs-example => examples}/minisim/src/acs/mgt.rs (100%) rename {satrs-example => examples}/minisim/src/acs/mod.rs (100%) rename {satrs-example => examples}/minisim/src/controller.rs (100%) rename {satrs-example => examples}/minisim/src/eps.rs (100%) rename {satrs-example => examples}/minisim/src/lib.rs (100%) rename {satrs-example => examples}/minisim/src/main.rs (100%) rename {satrs-example => examples}/minisim/src/test_helpers.rs (100%) rename {satrs-example => examples}/minisim/src/time.rs (100%) rename {satrs-example => examples}/minisim/src/udp.rs (100%) rename {satrs-example => examples/obsw-std}/.gitignore (100%) rename {satrs-example => examples/obsw-std}/CHANGELOG.md (100%) rename {satrs-example => examples/obsw-std}/Cargo.toml (80%) rename {embedded-examples/stm32f3-disco-rtic => examples/obsw-std}/LICENSE-APACHE (100%) rename {embedded-examples/stm32f3-disco-rtic => examples/obsw-std}/NOTICE (100%) rename {satrs-example => examples/obsw-std}/README.md (98%) rename {satrs-example => examples/obsw-std}/src/acs/ctrl.rs (100%) rename {satrs-example => examples/obsw-std}/src/acs/mgm.rs (100%) rename {satrs-example => examples/obsw-std}/src/acs/mgm_assembly.rs (100%) rename {satrs-example => examples/obsw-std}/src/acs/mgt.rs (100%) rename {satrs-example => examples/obsw-std}/src/acs/mod.rs (100%) rename {satrs-example => examples/obsw-std}/src/acs/subsystem.rs (100%) rename {satrs-example => examples/obsw-std}/src/ccsds.rs (100%) rename {satrs-example => examples/obsw-std}/src/config.rs (100%) rename {satrs-example => examples/obsw-std}/src/controller.rs (100%) rename {satrs-example => examples/obsw-std}/src/device_mode.rs (100%) rename {satrs-example => examples/obsw-std}/src/eps/mod.rs (100%) rename {satrs-example => examples/obsw-std}/src/eps/pcdu.rs (100%) rename {satrs-example => examples/obsw-std}/src/event_manager.rs (100%) rename {satrs-example => examples/obsw-std}/src/interface/mod.rs (100%) rename {satrs-example => examples/obsw-std}/src/interface/sim_client_udp.rs (100%) rename {satrs-example => examples/obsw-std}/src/interface/tcp.rs (100%) rename {satrs-example => examples/obsw-std}/src/interface/udp.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/events.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/hk.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/action.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/event.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/hk.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/mod.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/mode.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/scheduler.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/stack.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/pus/test.rs (100%) rename {satrs-example => examples/obsw-std}/src/legacy/requests.rs (100%) rename {satrs-example => examples/obsw-std}/src/lib.rs (100%) rename {satrs-example => examples/obsw-std}/src/logger.rs (100%) rename {satrs-example => examples/obsw-std}/src/main.rs (100%) rename {satrs-example => examples/obsw-std}/src/tmtc/mod.rs (100%) rename {satrs-example => examples/obsw-std}/src/tmtc/sender.rs (100%) rename {satrs-example => examples/obsw-std}/src/tmtc/tc_source.rs (100%) rename {satrs-example => examples/obsw-std}/src/tmtc/tm_sink.rs (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/.cargo/config.toml.template (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/.gitignore (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/Cargo.lock (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/Cargo.toml (96%) rename {embedded-examples/stm32h7-nucleo-rtic => examples/stm32f3-disco-rtic}/LICENSE-APACHE (100%) rename {satrs-example => examples/stm32f3-disco-rtic}/NOTICE (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/README.md (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/src/bin/blinky.rs (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/src/lib.rs (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/src/main.rs (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/vscode/.gitignore (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/vscode/extensions.json (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/vscode/launch.json (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/vscode/openocd-helpers.tcl (100%) rename {embedded-examples => examples}/stm32f3-disco-rtic/vscode/tasks.json (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/.cargo/config.toml.template (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/.gitignore (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/Cargo.lock (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/Cargo.toml (96%) rename {satrs-example => examples/stm32h7-nucleo-rtic}/LICENSE-APACHE (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/README.md (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/build.rs (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/docs/um2407-stm32h7-nucleo144-boards-mb1364-stmicroelectronics.pdf (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/memory.x.tmp (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/rust-toolchain.toml (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/src/bin/blinky.rs (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/src/bin/hello.rs (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/src/lib.rs (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/src/main.rs (100%) rename {embedded-examples => examples}/stm32h7-nucleo-rtic/tests/integration.rs (100%) rename {satrs-example => examples}/types/Cargo.toml (100%) rename {satrs-example => examples}/types/src/acs/ctrl.rs (100%) rename {satrs-example => examples}/types/src/acs/mgm.rs (100%) rename {satrs-example => examples}/types/src/acs/mgm_assembly.rs (100%) rename {satrs-example => examples}/types/src/acs/mgt.rs (100%) rename {satrs-example => examples}/types/src/acs/mod.rs (100%) rename {satrs-example => examples}/types/src/acs/subsystem.rs (100%) rename {satrs-example => examples}/types/src/ccsds.rs (100%) rename {satrs-example => examples}/types/src/control.rs (100%) rename {satrs-example => examples}/types/src/event_manager.rs (100%) rename {satrs-example => examples}/types/src/lib.rs (100%) rename {satrs-example => examples}/types/src/pcdu.rs (100%) rename {satrs-example => examples}/types/src/tmtc.rs (100%) rename {satrs-example => examples}/types/tests/ccsds_len.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index 56dbd33..2283da4 100644 --- a/Cargo.toml +++ b/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", ] diff --git a/README.md b/README.md index 4bc6ee4..4108c38 100644 --- a/README.md +++ b/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. diff --git a/satrs-example/client/Cargo.toml b/examples/client/Cargo.toml similarity index 92% rename from satrs-example/client/Cargo.toml rename to examples/client/Cargo.toml index bd28404..6ba5aa1 100644 --- a/satrs-example/client/Cargo.toml +++ b/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 } diff --git a/satrs-example/client/src/main.rs b/examples/client/src/main.rs similarity index 100% rename from satrs-example/client/src/main.rs rename to examples/client/src/main.rs diff --git a/embedded-examples/embedded-client/Cargo.toml b/examples/embedded-client/Cargo.toml similarity index 89% rename from embedded-examples/embedded-client/Cargo.toml rename to examples/embedded-client/Cargo.toml index d7cce99..b462575 100644 --- a/embedded-examples/embedded-client/Cargo.toml +++ b/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" diff --git a/embedded-examples/embedded-client/config.toml b/examples/embedded-client/config.toml similarity index 100% rename from embedded-examples/embedded-client/config.toml rename to examples/embedded-client/config.toml diff --git a/embedded-examples/embedded-client/src/bin/stm32f3-client.rs b/examples/embedded-client/src/bin/stm32f3-client.rs similarity index 100% rename from embedded-examples/embedded-client/src/bin/stm32f3-client.rs rename to examples/embedded-client/src/bin/stm32f3-client.rs diff --git a/embedded-examples/embedded-client/src/bin/stm32h7-client.rs b/examples/embedded-client/src/bin/stm32h7-client.rs similarity index 100% rename from embedded-examples/embedded-client/src/bin/stm32h7-client.rs rename to examples/embedded-client/src/bin/stm32h7-client.rs diff --git a/embedded-examples/embedded-client/src/lib.rs b/examples/embedded-client/src/lib.rs similarity index 100% rename from embedded-examples/embedded-client/src/lib.rs rename to examples/embedded-client/src/lib.rs diff --git a/embedded-examples/types/Cargo.toml b/examples/embedded-types/Cargo.toml similarity index 100% rename from embedded-examples/types/Cargo.toml rename to examples/embedded-types/Cargo.toml diff --git a/embedded-examples/types/src/lib.rs b/examples/embedded-types/src/lib.rs similarity index 100% rename from embedded-examples/types/src/lib.rs rename to examples/embedded-types/src/lib.rs diff --git a/satrs-example/minisim/Cargo.toml b/examples/minisim/Cargo.toml similarity index 100% rename from satrs-example/minisim/Cargo.toml rename to examples/minisim/Cargo.toml diff --git a/satrs-example/minisim/README.md b/examples/minisim/README.md similarity index 95% rename from satrs-example/minisim/README.md rename to examples/minisim/README.md index b55d3e9..ce9090b 100644 --- a/satrs-example/minisim/README.md +++ b/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 diff --git a/satrs-example/minisim/src/acs/mgm.rs b/examples/minisim/src/acs/mgm.rs similarity index 100% rename from satrs-example/minisim/src/acs/mgm.rs rename to examples/minisim/src/acs/mgm.rs diff --git a/satrs-example/minisim/src/acs/mgt.rs b/examples/minisim/src/acs/mgt.rs similarity index 100% rename from satrs-example/minisim/src/acs/mgt.rs rename to examples/minisim/src/acs/mgt.rs diff --git a/satrs-example/minisim/src/acs/mod.rs b/examples/minisim/src/acs/mod.rs similarity index 100% rename from satrs-example/minisim/src/acs/mod.rs rename to examples/minisim/src/acs/mod.rs diff --git a/satrs-example/minisim/src/controller.rs b/examples/minisim/src/controller.rs similarity index 100% rename from satrs-example/minisim/src/controller.rs rename to examples/minisim/src/controller.rs diff --git a/satrs-example/minisim/src/eps.rs b/examples/minisim/src/eps.rs similarity index 100% rename from satrs-example/minisim/src/eps.rs rename to examples/minisim/src/eps.rs diff --git a/satrs-example/minisim/src/lib.rs b/examples/minisim/src/lib.rs similarity index 100% rename from satrs-example/minisim/src/lib.rs rename to examples/minisim/src/lib.rs diff --git a/satrs-example/minisim/src/main.rs b/examples/minisim/src/main.rs similarity index 100% rename from satrs-example/minisim/src/main.rs rename to examples/minisim/src/main.rs diff --git a/satrs-example/minisim/src/test_helpers.rs b/examples/minisim/src/test_helpers.rs similarity index 100% rename from satrs-example/minisim/src/test_helpers.rs rename to examples/minisim/src/test_helpers.rs diff --git a/satrs-example/minisim/src/time.rs b/examples/minisim/src/time.rs similarity index 100% rename from satrs-example/minisim/src/time.rs rename to examples/minisim/src/time.rs diff --git a/satrs-example/minisim/src/udp.rs b/examples/minisim/src/udp.rs similarity index 100% rename from satrs-example/minisim/src/udp.rs rename to examples/minisim/src/udp.rs diff --git a/satrs-example/.gitignore b/examples/obsw-std/.gitignore similarity index 100% rename from satrs-example/.gitignore rename to examples/obsw-std/.gitignore diff --git a/satrs-example/CHANGELOG.md b/examples/obsw-std/CHANGELOG.md similarity index 100% rename from satrs-example/CHANGELOG.md rename to examples/obsw-std/CHANGELOG.md diff --git a/satrs-example/Cargo.toml b/examples/obsw-std/Cargo.toml similarity index 80% rename from satrs-example/Cargo.toml rename to examples/obsw-std/Cargo.toml index a953281..d43ab3c 100644 --- a/satrs-example/Cargo.toml +++ b/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"] diff --git a/embedded-examples/stm32f3-disco-rtic/LICENSE-APACHE b/examples/obsw-std/LICENSE-APACHE similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/LICENSE-APACHE rename to examples/obsw-std/LICENSE-APACHE diff --git a/embedded-examples/stm32f3-disco-rtic/NOTICE b/examples/obsw-std/NOTICE similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/NOTICE rename to examples/obsw-std/NOTICE diff --git a/satrs-example/README.md b/examples/obsw-std/README.md similarity index 98% rename from satrs-example/README.md rename to examples/obsw-std/README.md index 4e176f0..28ee29a 100644 --- a/satrs-example/README.md +++ b/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. diff --git a/satrs-example/src/acs/ctrl.rs b/examples/obsw-std/src/acs/ctrl.rs similarity index 100% rename from satrs-example/src/acs/ctrl.rs rename to examples/obsw-std/src/acs/ctrl.rs diff --git a/satrs-example/src/acs/mgm.rs b/examples/obsw-std/src/acs/mgm.rs similarity index 100% rename from satrs-example/src/acs/mgm.rs rename to examples/obsw-std/src/acs/mgm.rs diff --git a/satrs-example/src/acs/mgm_assembly.rs b/examples/obsw-std/src/acs/mgm_assembly.rs similarity index 100% rename from satrs-example/src/acs/mgm_assembly.rs rename to examples/obsw-std/src/acs/mgm_assembly.rs diff --git a/satrs-example/src/acs/mgt.rs b/examples/obsw-std/src/acs/mgt.rs similarity index 100% rename from satrs-example/src/acs/mgt.rs rename to examples/obsw-std/src/acs/mgt.rs diff --git a/satrs-example/src/acs/mod.rs b/examples/obsw-std/src/acs/mod.rs similarity index 100% rename from satrs-example/src/acs/mod.rs rename to examples/obsw-std/src/acs/mod.rs diff --git a/satrs-example/src/acs/subsystem.rs b/examples/obsw-std/src/acs/subsystem.rs similarity index 100% rename from satrs-example/src/acs/subsystem.rs rename to examples/obsw-std/src/acs/subsystem.rs diff --git a/satrs-example/src/ccsds.rs b/examples/obsw-std/src/ccsds.rs similarity index 100% rename from satrs-example/src/ccsds.rs rename to examples/obsw-std/src/ccsds.rs diff --git a/satrs-example/src/config.rs b/examples/obsw-std/src/config.rs similarity index 100% rename from satrs-example/src/config.rs rename to examples/obsw-std/src/config.rs diff --git a/satrs-example/src/controller.rs b/examples/obsw-std/src/controller.rs similarity index 100% rename from satrs-example/src/controller.rs rename to examples/obsw-std/src/controller.rs diff --git a/satrs-example/src/device_mode.rs b/examples/obsw-std/src/device_mode.rs similarity index 100% rename from satrs-example/src/device_mode.rs rename to examples/obsw-std/src/device_mode.rs diff --git a/satrs-example/src/eps/mod.rs b/examples/obsw-std/src/eps/mod.rs similarity index 100% rename from satrs-example/src/eps/mod.rs rename to examples/obsw-std/src/eps/mod.rs diff --git a/satrs-example/src/eps/pcdu.rs b/examples/obsw-std/src/eps/pcdu.rs similarity index 100% rename from satrs-example/src/eps/pcdu.rs rename to examples/obsw-std/src/eps/pcdu.rs diff --git a/satrs-example/src/event_manager.rs b/examples/obsw-std/src/event_manager.rs similarity index 100% rename from satrs-example/src/event_manager.rs rename to examples/obsw-std/src/event_manager.rs diff --git a/satrs-example/src/interface/mod.rs b/examples/obsw-std/src/interface/mod.rs similarity index 100% rename from satrs-example/src/interface/mod.rs rename to examples/obsw-std/src/interface/mod.rs diff --git a/satrs-example/src/interface/sim_client_udp.rs b/examples/obsw-std/src/interface/sim_client_udp.rs similarity index 100% rename from satrs-example/src/interface/sim_client_udp.rs rename to examples/obsw-std/src/interface/sim_client_udp.rs diff --git a/satrs-example/src/interface/tcp.rs b/examples/obsw-std/src/interface/tcp.rs similarity index 100% rename from satrs-example/src/interface/tcp.rs rename to examples/obsw-std/src/interface/tcp.rs diff --git a/satrs-example/src/interface/udp.rs b/examples/obsw-std/src/interface/udp.rs similarity index 100% rename from satrs-example/src/interface/udp.rs rename to examples/obsw-std/src/interface/udp.rs diff --git a/satrs-example/src/legacy/events.rs b/examples/obsw-std/src/legacy/events.rs similarity index 100% rename from satrs-example/src/legacy/events.rs rename to examples/obsw-std/src/legacy/events.rs diff --git a/satrs-example/src/legacy/hk.rs b/examples/obsw-std/src/legacy/hk.rs similarity index 100% rename from satrs-example/src/legacy/hk.rs rename to examples/obsw-std/src/legacy/hk.rs diff --git a/satrs-example/src/legacy/pus/action.rs b/examples/obsw-std/src/legacy/pus/action.rs similarity index 100% rename from satrs-example/src/legacy/pus/action.rs rename to examples/obsw-std/src/legacy/pus/action.rs diff --git a/satrs-example/src/legacy/pus/event.rs b/examples/obsw-std/src/legacy/pus/event.rs similarity index 100% rename from satrs-example/src/legacy/pus/event.rs rename to examples/obsw-std/src/legacy/pus/event.rs diff --git a/satrs-example/src/legacy/pus/hk.rs b/examples/obsw-std/src/legacy/pus/hk.rs similarity index 100% rename from satrs-example/src/legacy/pus/hk.rs rename to examples/obsw-std/src/legacy/pus/hk.rs diff --git a/satrs-example/src/legacy/pus/mod.rs b/examples/obsw-std/src/legacy/pus/mod.rs similarity index 100% rename from satrs-example/src/legacy/pus/mod.rs rename to examples/obsw-std/src/legacy/pus/mod.rs diff --git a/satrs-example/src/legacy/pus/mode.rs b/examples/obsw-std/src/legacy/pus/mode.rs similarity index 100% rename from satrs-example/src/legacy/pus/mode.rs rename to examples/obsw-std/src/legacy/pus/mode.rs diff --git a/satrs-example/src/legacy/pus/scheduler.rs b/examples/obsw-std/src/legacy/pus/scheduler.rs similarity index 100% rename from satrs-example/src/legacy/pus/scheduler.rs rename to examples/obsw-std/src/legacy/pus/scheduler.rs diff --git a/satrs-example/src/legacy/pus/stack.rs b/examples/obsw-std/src/legacy/pus/stack.rs similarity index 100% rename from satrs-example/src/legacy/pus/stack.rs rename to examples/obsw-std/src/legacy/pus/stack.rs diff --git a/satrs-example/src/legacy/pus/test.rs b/examples/obsw-std/src/legacy/pus/test.rs similarity index 100% rename from satrs-example/src/legacy/pus/test.rs rename to examples/obsw-std/src/legacy/pus/test.rs diff --git a/satrs-example/src/legacy/requests.rs b/examples/obsw-std/src/legacy/requests.rs similarity index 100% rename from satrs-example/src/legacy/requests.rs rename to examples/obsw-std/src/legacy/requests.rs diff --git a/satrs-example/src/lib.rs b/examples/obsw-std/src/lib.rs similarity index 100% rename from satrs-example/src/lib.rs rename to examples/obsw-std/src/lib.rs diff --git a/satrs-example/src/logger.rs b/examples/obsw-std/src/logger.rs similarity index 100% rename from satrs-example/src/logger.rs rename to examples/obsw-std/src/logger.rs diff --git a/satrs-example/src/main.rs b/examples/obsw-std/src/main.rs similarity index 100% rename from satrs-example/src/main.rs rename to examples/obsw-std/src/main.rs diff --git a/satrs-example/src/tmtc/mod.rs b/examples/obsw-std/src/tmtc/mod.rs similarity index 100% rename from satrs-example/src/tmtc/mod.rs rename to examples/obsw-std/src/tmtc/mod.rs diff --git a/satrs-example/src/tmtc/sender.rs b/examples/obsw-std/src/tmtc/sender.rs similarity index 100% rename from satrs-example/src/tmtc/sender.rs rename to examples/obsw-std/src/tmtc/sender.rs diff --git a/satrs-example/src/tmtc/tc_source.rs b/examples/obsw-std/src/tmtc/tc_source.rs similarity index 100% rename from satrs-example/src/tmtc/tc_source.rs rename to examples/obsw-std/src/tmtc/tc_source.rs diff --git a/satrs-example/src/tmtc/tm_sink.rs b/examples/obsw-std/src/tmtc/tm_sink.rs similarity index 100% rename from satrs-example/src/tmtc/tm_sink.rs rename to examples/obsw-std/src/tmtc/tm_sink.rs diff --git a/embedded-examples/stm32f3-disco-rtic/.cargo/config.toml.template b/examples/stm32f3-disco-rtic/.cargo/config.toml.template similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/.cargo/config.toml.template rename to examples/stm32f3-disco-rtic/.cargo/config.toml.template diff --git a/embedded-examples/stm32f3-disco-rtic/.gitignore b/examples/stm32f3-disco-rtic/.gitignore similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/.gitignore rename to examples/stm32f3-disco-rtic/.gitignore diff --git a/embedded-examples/stm32f3-disco-rtic/Cargo.lock b/examples/stm32f3-disco-rtic/Cargo.lock similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/Cargo.lock rename to examples/stm32f3-disco-rtic/Cargo.lock diff --git a/embedded-examples/stm32f3-disco-rtic/Cargo.toml b/examples/stm32f3-disco-rtic/Cargo.toml similarity index 96% rename from embedded-examples/stm32f3-disco-rtic/Cargo.toml rename to examples/stm32f3-disco-rtic/Cargo.toml index 062e628..d83cbc2 100644 --- a/embedded-examples/stm32f3-disco-rtic/Cargo.toml +++ b/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" diff --git a/embedded-examples/stm32h7-nucleo-rtic/LICENSE-APACHE b/examples/stm32f3-disco-rtic/LICENSE-APACHE similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/LICENSE-APACHE rename to examples/stm32f3-disco-rtic/LICENSE-APACHE diff --git a/satrs-example/NOTICE b/examples/stm32f3-disco-rtic/NOTICE similarity index 100% rename from satrs-example/NOTICE rename to examples/stm32f3-disco-rtic/NOTICE diff --git a/embedded-examples/stm32f3-disco-rtic/README.md b/examples/stm32f3-disco-rtic/README.md similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/README.md rename to examples/stm32f3-disco-rtic/README.md diff --git a/embedded-examples/stm32f3-disco-rtic/src/bin/blinky.rs b/examples/stm32f3-disco-rtic/src/bin/blinky.rs similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/src/bin/blinky.rs rename to examples/stm32f3-disco-rtic/src/bin/blinky.rs diff --git a/embedded-examples/stm32f3-disco-rtic/src/lib.rs b/examples/stm32f3-disco-rtic/src/lib.rs similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/src/lib.rs rename to examples/stm32f3-disco-rtic/src/lib.rs diff --git a/embedded-examples/stm32f3-disco-rtic/src/main.rs b/examples/stm32f3-disco-rtic/src/main.rs similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/src/main.rs rename to examples/stm32f3-disco-rtic/src/main.rs diff --git a/embedded-examples/stm32f3-disco-rtic/vscode/.gitignore b/examples/stm32f3-disco-rtic/vscode/.gitignore similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/vscode/.gitignore rename to examples/stm32f3-disco-rtic/vscode/.gitignore diff --git a/embedded-examples/stm32f3-disco-rtic/vscode/extensions.json b/examples/stm32f3-disco-rtic/vscode/extensions.json similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/vscode/extensions.json rename to examples/stm32f3-disco-rtic/vscode/extensions.json diff --git a/embedded-examples/stm32f3-disco-rtic/vscode/launch.json b/examples/stm32f3-disco-rtic/vscode/launch.json similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/vscode/launch.json rename to examples/stm32f3-disco-rtic/vscode/launch.json diff --git a/embedded-examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl b/examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl rename to examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl diff --git a/embedded-examples/stm32f3-disco-rtic/vscode/tasks.json b/examples/stm32f3-disco-rtic/vscode/tasks.json similarity index 100% rename from embedded-examples/stm32f3-disco-rtic/vscode/tasks.json rename to examples/stm32f3-disco-rtic/vscode/tasks.json diff --git a/embedded-examples/stm32h7-nucleo-rtic/.cargo/config.toml.template b/examples/stm32h7-nucleo-rtic/.cargo/config.toml.template similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/.cargo/config.toml.template rename to examples/stm32h7-nucleo-rtic/.cargo/config.toml.template diff --git a/embedded-examples/stm32h7-nucleo-rtic/.gitignore b/examples/stm32h7-nucleo-rtic/.gitignore similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/.gitignore rename to examples/stm32h7-nucleo-rtic/.gitignore diff --git a/embedded-examples/stm32h7-nucleo-rtic/Cargo.lock b/examples/stm32h7-nucleo-rtic/Cargo.lock similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/Cargo.lock rename to examples/stm32h7-nucleo-rtic/Cargo.lock diff --git a/embedded-examples/stm32h7-nucleo-rtic/Cargo.toml b/examples/stm32h7-nucleo-rtic/Cargo.toml similarity index 96% rename from embedded-examples/stm32h7-nucleo-rtic/Cargo.toml rename to examples/stm32h7-nucleo-rtic/Cargo.toml index 11b3ab3..5f58968 100644 --- a/embedded-examples/stm32h7-nucleo-rtic/Cargo.toml +++ b/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" diff --git a/satrs-example/LICENSE-APACHE b/examples/stm32h7-nucleo-rtic/LICENSE-APACHE similarity index 100% rename from satrs-example/LICENSE-APACHE rename to examples/stm32h7-nucleo-rtic/LICENSE-APACHE diff --git a/embedded-examples/stm32h7-nucleo-rtic/README.md b/examples/stm32h7-nucleo-rtic/README.md similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/README.md rename to examples/stm32h7-nucleo-rtic/README.md diff --git a/embedded-examples/stm32h7-nucleo-rtic/build.rs b/examples/stm32h7-nucleo-rtic/build.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/build.rs rename to examples/stm32h7-nucleo-rtic/build.rs diff --git a/embedded-examples/stm32h7-nucleo-rtic/docs/um2407-stm32h7-nucleo144-boards-mb1364-stmicroelectronics.pdf b/examples/stm32h7-nucleo-rtic/docs/um2407-stm32h7-nucleo144-boards-mb1364-stmicroelectronics.pdf similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/docs/um2407-stm32h7-nucleo144-boards-mb1364-stmicroelectronics.pdf rename to examples/stm32h7-nucleo-rtic/docs/um2407-stm32h7-nucleo144-boards-mb1364-stmicroelectronics.pdf diff --git a/embedded-examples/stm32h7-nucleo-rtic/memory.x.tmp b/examples/stm32h7-nucleo-rtic/memory.x.tmp similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/memory.x.tmp rename to examples/stm32h7-nucleo-rtic/memory.x.tmp diff --git a/embedded-examples/stm32h7-nucleo-rtic/rust-toolchain.toml b/examples/stm32h7-nucleo-rtic/rust-toolchain.toml similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/rust-toolchain.toml rename to examples/stm32h7-nucleo-rtic/rust-toolchain.toml diff --git a/embedded-examples/stm32h7-nucleo-rtic/src/bin/blinky.rs b/examples/stm32h7-nucleo-rtic/src/bin/blinky.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/src/bin/blinky.rs rename to examples/stm32h7-nucleo-rtic/src/bin/blinky.rs diff --git a/embedded-examples/stm32h7-nucleo-rtic/src/bin/hello.rs b/examples/stm32h7-nucleo-rtic/src/bin/hello.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/src/bin/hello.rs rename to examples/stm32h7-nucleo-rtic/src/bin/hello.rs diff --git a/embedded-examples/stm32h7-nucleo-rtic/src/lib.rs b/examples/stm32h7-nucleo-rtic/src/lib.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/src/lib.rs rename to examples/stm32h7-nucleo-rtic/src/lib.rs diff --git a/embedded-examples/stm32h7-nucleo-rtic/src/main.rs b/examples/stm32h7-nucleo-rtic/src/main.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/src/main.rs rename to examples/stm32h7-nucleo-rtic/src/main.rs diff --git a/embedded-examples/stm32h7-nucleo-rtic/tests/integration.rs b/examples/stm32h7-nucleo-rtic/tests/integration.rs similarity index 100% rename from embedded-examples/stm32h7-nucleo-rtic/tests/integration.rs rename to examples/stm32h7-nucleo-rtic/tests/integration.rs diff --git a/satrs-example/types/Cargo.toml b/examples/types/Cargo.toml similarity index 100% rename from satrs-example/types/Cargo.toml rename to examples/types/Cargo.toml diff --git a/satrs-example/types/src/acs/ctrl.rs b/examples/types/src/acs/ctrl.rs similarity index 100% rename from satrs-example/types/src/acs/ctrl.rs rename to examples/types/src/acs/ctrl.rs diff --git a/satrs-example/types/src/acs/mgm.rs b/examples/types/src/acs/mgm.rs similarity index 100% rename from satrs-example/types/src/acs/mgm.rs rename to examples/types/src/acs/mgm.rs diff --git a/satrs-example/types/src/acs/mgm_assembly.rs b/examples/types/src/acs/mgm_assembly.rs similarity index 100% rename from satrs-example/types/src/acs/mgm_assembly.rs rename to examples/types/src/acs/mgm_assembly.rs diff --git a/satrs-example/types/src/acs/mgt.rs b/examples/types/src/acs/mgt.rs similarity index 100% rename from satrs-example/types/src/acs/mgt.rs rename to examples/types/src/acs/mgt.rs diff --git a/satrs-example/types/src/acs/mod.rs b/examples/types/src/acs/mod.rs similarity index 100% rename from satrs-example/types/src/acs/mod.rs rename to examples/types/src/acs/mod.rs diff --git a/satrs-example/types/src/acs/subsystem.rs b/examples/types/src/acs/subsystem.rs similarity index 100% rename from satrs-example/types/src/acs/subsystem.rs rename to examples/types/src/acs/subsystem.rs diff --git a/satrs-example/types/src/ccsds.rs b/examples/types/src/ccsds.rs similarity index 100% rename from satrs-example/types/src/ccsds.rs rename to examples/types/src/ccsds.rs diff --git a/satrs-example/types/src/control.rs b/examples/types/src/control.rs similarity index 100% rename from satrs-example/types/src/control.rs rename to examples/types/src/control.rs diff --git a/satrs-example/types/src/event_manager.rs b/examples/types/src/event_manager.rs similarity index 100% rename from satrs-example/types/src/event_manager.rs rename to examples/types/src/event_manager.rs diff --git a/satrs-example/types/src/lib.rs b/examples/types/src/lib.rs similarity index 100% rename from satrs-example/types/src/lib.rs rename to examples/types/src/lib.rs diff --git a/satrs-example/types/src/pcdu.rs b/examples/types/src/pcdu.rs similarity index 100% rename from satrs-example/types/src/pcdu.rs rename to examples/types/src/pcdu.rs diff --git a/satrs-example/types/src/tmtc.rs b/examples/types/src/tmtc.rs similarity index 100% rename from satrs-example/types/src/tmtc.rs rename to examples/types/src/tmtc.rs diff --git a/satrs-example/types/tests/ccsds_len.rs b/examples/types/tests/ccsds_len.rs similarity index 100% rename from satrs-example/types/tests/ccsds_len.rs rename to examples/types/tests/ccsds_len.rs diff --git a/experiments/satrs-gen/src/main.rs b/experiments/satrs-gen/src/main.rs index f8d61c1..1f8b360 100644 --- a/experiments/satrs-gen/src/main.rs +++ b/experiments/satrs-gen/src/main.rs @@ -12,7 +12,7 @@ fn main() -> io::Result<()> { let config_str = fs::read_to_string("components.toml").expect("Unable to read file"); let config: Value = toml::from_str(&config_str).expect("Unable to parse TOML"); - let mut output = File::create("../satrs-example/src/ids.rs")?; + let mut output = File::create("../../examples/obsw-std/src/ids.rs")?; generate_rust_code(&config, &mut output); Ok(()) diff --git a/justfile b/justfile index dff375a..6788fd8 100644 --- a/justfile +++ b/justfile @@ -14,11 +14,11 @@ test: embedded: embedded-stm32h7 embedded-stm32f3 cargo check -p satrs --target=thumbv7em-none-eabihf --no-default-features -[working-directory:"embedded-examples/stm32h7-nucleo-rtic"] +[working-directory:"examples/stm32h7-nucleo-rtic"] embedded-stm32h7: cargo build --target=thumbv7em-none-eabihf --release -[working-directory:"embedded-examples/stm32f3-disco-rtic"] +[working-directory:"examples/stm32f3-disco-rtic"] embedded-stm32f3: cargo build --target=thumbv7em-none-eabihf --release diff --git a/satrs-book/src/example.md b/satrs-book/src/example.md index 26e8648..551e8cb 100644 --- a/satrs-book/src/example.md +++ b/satrs-book/src/example.md @@ -1,7 +1,7 @@ # sat-rs Example Application The `sat-rs` library includes a monolithic example application which can be found inside -the [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example) +the [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std) subdirectory of the repository. The primary purpose of this example application is to show how the various components of the sat-rs framework could be used as part of a larger on-board software application. diff --git a/satrs-book/src/introduction.md b/satrs-book/src/introduction.md index daa94d8..dcfe6be 100644 --- a/satrs-book/src/introduction.md +++ b/satrs-book/src/introduction.md @@ -25,10 +25,10 @@ frameworks. # Getting started with the example -The [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example) +The [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std) provides various practical usage examples of the `sat-rs` framework. If you are more interested in the practical application of `sat-rs` inside an application, it is recommended to have a look at -the example application. The [`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/minisim) +the example application. The [`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/minisim) application complements the example application and can be used to simulate some physical devices for the `satrs-example` device handlers. diff --git a/satrs/src/hal/std/udp_server.rs b/satrs/src/hal/std/udp_server.rs index 1d0be11..8d13ffb 100644 --- a/satrs/src/hal/std/udp_server.rs +++ b/satrs/src/hal/std/udp_server.rs @@ -55,9 +55,9 @@ use std::vec::Vec; /// matches!(packet_receiver.try_recv(), Err(mpsc::TryRecvError::Empty)); /// ``` /// -/// The [satrs-example crate](https://egit.irs.uni-stuttgart.de/rust/fsrc-launchpad/src/branch/main/satrs-example) +/// The [satrs-example crate](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std) /// server code also includes -/// [example code](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/src/tmtc.rs#L67) +/// [example code](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std/src/tmtc.rs#L67) /// on how to use this TC server. It uses the server to receive PUS telecommands on a specific port /// and then forwards them to a generic CCSDS packet receiver. pub struct UdpTcServer, SendError> { diff --git a/satrs/src/legacy/event_man.rs b/satrs/src/legacy/event_man.rs index 81dd35a..31371c5 100644 --- a/satrs/src/legacy/event_man.rs +++ b/satrs/src/legacy/event_man.rs @@ -43,10 +43,10 @@ //! for a concrete example using multi-threading where events are routed to //! different threads. //! -//! The [satrs-example](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example) +//! The [satrs-example](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std) //! also contains a full event manager instance and exposes a test event via the PUS test service. -//! The [PUS event](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/src/pus/event.rs) -//! module and the generic [events module](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/src/events.rs) +//! The [PUS event](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std/src/pus/event.rs) +//! module and the generic [events module](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std/src/events.rs) //! show how the event management modules can be integrated into a more complex software. use crate::{ ComponentId, diff --git a/satrs/src/legacy/event_man_legacy.rs b/satrs/src/legacy/event_man_legacy.rs index d435703..9a9a252 100644 --- a/satrs/src/legacy/event_man_legacy.rs +++ b/satrs/src/legacy/event_man_legacy.rs @@ -45,10 +45,10 @@ //! for a concrete example using multi-threading where events are routed to //! different threads. //! -//! The [satrs-example](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example) +//! The [satrs-example](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std) //! also contains a full event manager instance and exposes a test event via the PUS test service. -//! The [PUS event](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/src/pus/event.rs) -//! module and the generic [events module](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example/src/events.rs) +//! The [PUS event](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std/src/pus/event.rs) +//! module and the generic [events module](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/examples/obsw-std/src/events.rs) //! show how the event management modules can be integrated into a more complex software. use crate::legacy::events_legacy::{EventU16, EventU32, GenericEvent, LargestEventRaw, LargestGroupIdRaw}; use crate::params::Params;