From 31cc4e1f81e44efbec37e0610dce15bfaf3eedfb Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sun, 19 May 2024 21:25:03 +0200 Subject: [PATCH] better naming for embedded examples --- README.md | 9 +++++++-- .../.cargo/def_config.toml | 0 .../.gitignore | 0 .../Cargo.lock | 0 .../Cargo.toml | 4 ++-- .../LICENSE-APACHE | 0 .../NOTICE | 0 .../README.md | 0 .../STM32F303.svd | 0 .../legacy/jlink.gdb | 0 .../legacy/openocd.cfg | 0 .../legacy/openocd.gdb | 0 .../memory.x | 0 .../pyclient/.gitignore | 0 .../pyclient/def_tmtc_conf.json | 0 .../pyclient/main.py | 0 .../pyclient/requirements.txt | 0 .../src/bin/blinky.rs | 0 .../src/lib.rs | 0 .../src/main.rs | 0 .../vscode/.gitignore | 0 .../vscode/extensions.json | 0 .../vscode/launch.json | 4 ++-- .../vscode/openocd-helpers.tcl | 0 .../vscode/tasks.json | 0 25 files changed, 11 insertions(+), 6 deletions(-) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/.cargo/def_config.toml (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/.gitignore (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/Cargo.lock (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/Cargo.toml (95%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/LICENSE-APACHE (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/NOTICE (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/README.md (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/STM32F303.svd (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/legacy/jlink.gdb (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/legacy/openocd.cfg (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/legacy/openocd.gdb (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/memory.x (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/pyclient/.gitignore (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/pyclient/def_tmtc_conf.json (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/pyclient/main.py (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/pyclient/requirements.txt (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/src/bin/blinky.rs (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/src/lib.rs (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/src/main.rs (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/vscode/.gitignore (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/vscode/extensions.json (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/vscode/launch.json (90%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/vscode/openocd-helpers.tcl (100%) rename embedded-examples/{satrs-example-stm32f3-disco => stm32f3-disco-rtic}/vscode/tasks.json (100%) diff --git a/README.md b/README.md index 6ff1f6b..97630c2 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,14 @@ This project currently contains following crates: on a host computer or on any system with a standard runtime like a Raspberry Pi. * [`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-example-stm32f3-disco`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-examples/satrs-example-stm32f3-disco): +* [`satrs-stm32f3-disco-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-examples/satrs-stm32f3-disco-rtic): Example of a simple example using low-level sat-rs components on a bare-metal system - with constrained resources. + with constrained resources. This example uses the [RTIC](https://github.com/rtic-rs/rtic) + framework on the STM32F3-Discovery device. +* [`satrs-stm32h743zit-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-examples/satrs-stm32h743zit-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. Each project has its own `CHANGELOG.md`. diff --git a/embedded-examples/satrs-example-stm32f3-disco/.cargo/def_config.toml b/embedded-examples/stm32f3-disco-rtic/.cargo/def_config.toml similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/.cargo/def_config.toml rename to embedded-examples/stm32f3-disco-rtic/.cargo/def_config.toml diff --git a/embedded-examples/satrs-example-stm32f3-disco/.gitignore b/embedded-examples/stm32f3-disco-rtic/.gitignore similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/.gitignore rename to embedded-examples/stm32f3-disco-rtic/.gitignore diff --git a/embedded-examples/satrs-example-stm32f3-disco/Cargo.lock b/embedded-examples/stm32f3-disco-rtic/Cargo.lock similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/Cargo.lock rename to embedded-examples/stm32f3-disco-rtic/Cargo.lock diff --git a/embedded-examples/satrs-example-stm32f3-disco/Cargo.toml b/embedded-examples/stm32f3-disco-rtic/Cargo.toml similarity index 95% rename from embedded-examples/satrs-example-stm32f3-disco/Cargo.toml rename to embedded-examples/stm32f3-disco-rtic/Cargo.toml index c149dd4..35553bb 100644 --- a/embedded-examples/satrs-example-stm32f3-disco/Cargo.toml +++ b/embedded-examples/stm32f3-disco-rtic/Cargo.toml @@ -1,8 +1,8 @@ [package] -name = "satrs-example-stm32f3-disco" +name = "satrs-stm32f3-disco-rtic" version = "0.1.0" edition = "2021" -default-run = "satrs-example-stm32f3-disco" +default-run = "satrs-stm32f3-disco-rtic" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/embedded-examples/satrs-example-stm32f3-disco/LICENSE-APACHE b/embedded-examples/stm32f3-disco-rtic/LICENSE-APACHE similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/LICENSE-APACHE rename to embedded-examples/stm32f3-disco-rtic/LICENSE-APACHE diff --git a/embedded-examples/satrs-example-stm32f3-disco/NOTICE b/embedded-examples/stm32f3-disco-rtic/NOTICE similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/NOTICE rename to embedded-examples/stm32f3-disco-rtic/NOTICE diff --git a/embedded-examples/satrs-example-stm32f3-disco/README.md b/embedded-examples/stm32f3-disco-rtic/README.md similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/README.md rename to embedded-examples/stm32f3-disco-rtic/README.md diff --git a/embedded-examples/satrs-example-stm32f3-disco/STM32F303.svd b/embedded-examples/stm32f3-disco-rtic/STM32F303.svd similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/STM32F303.svd rename to embedded-examples/stm32f3-disco-rtic/STM32F303.svd diff --git a/embedded-examples/satrs-example-stm32f3-disco/legacy/jlink.gdb b/embedded-examples/stm32f3-disco-rtic/legacy/jlink.gdb similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/legacy/jlink.gdb rename to embedded-examples/stm32f3-disco-rtic/legacy/jlink.gdb diff --git a/embedded-examples/satrs-example-stm32f3-disco/legacy/openocd.cfg b/embedded-examples/stm32f3-disco-rtic/legacy/openocd.cfg similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/legacy/openocd.cfg rename to embedded-examples/stm32f3-disco-rtic/legacy/openocd.cfg diff --git a/embedded-examples/satrs-example-stm32f3-disco/legacy/openocd.gdb b/embedded-examples/stm32f3-disco-rtic/legacy/openocd.gdb similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/legacy/openocd.gdb rename to embedded-examples/stm32f3-disco-rtic/legacy/openocd.gdb diff --git a/embedded-examples/satrs-example-stm32f3-disco/memory.x b/embedded-examples/stm32f3-disco-rtic/memory.x similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/memory.x rename to embedded-examples/stm32f3-disco-rtic/memory.x diff --git a/embedded-examples/satrs-example-stm32f3-disco/pyclient/.gitignore b/embedded-examples/stm32f3-disco-rtic/pyclient/.gitignore similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/pyclient/.gitignore rename to embedded-examples/stm32f3-disco-rtic/pyclient/.gitignore diff --git a/embedded-examples/satrs-example-stm32f3-disco/pyclient/def_tmtc_conf.json b/embedded-examples/stm32f3-disco-rtic/pyclient/def_tmtc_conf.json similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/pyclient/def_tmtc_conf.json rename to embedded-examples/stm32f3-disco-rtic/pyclient/def_tmtc_conf.json diff --git a/embedded-examples/satrs-example-stm32f3-disco/pyclient/main.py b/embedded-examples/stm32f3-disco-rtic/pyclient/main.py similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/pyclient/main.py rename to embedded-examples/stm32f3-disco-rtic/pyclient/main.py diff --git a/embedded-examples/satrs-example-stm32f3-disco/pyclient/requirements.txt b/embedded-examples/stm32f3-disco-rtic/pyclient/requirements.txt similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/pyclient/requirements.txt rename to embedded-examples/stm32f3-disco-rtic/pyclient/requirements.txt diff --git a/embedded-examples/satrs-example-stm32f3-disco/src/bin/blinky.rs b/embedded-examples/stm32f3-disco-rtic/src/bin/blinky.rs similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/src/bin/blinky.rs rename to embedded-examples/stm32f3-disco-rtic/src/bin/blinky.rs diff --git a/embedded-examples/satrs-example-stm32f3-disco/src/lib.rs b/embedded-examples/stm32f3-disco-rtic/src/lib.rs similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/src/lib.rs rename to embedded-examples/stm32f3-disco-rtic/src/lib.rs diff --git a/embedded-examples/satrs-example-stm32f3-disco/src/main.rs b/embedded-examples/stm32f3-disco-rtic/src/main.rs similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/src/main.rs rename to embedded-examples/stm32f3-disco-rtic/src/main.rs diff --git a/embedded-examples/satrs-example-stm32f3-disco/vscode/.gitignore b/embedded-examples/stm32f3-disco-rtic/vscode/.gitignore similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/vscode/.gitignore rename to embedded-examples/stm32f3-disco-rtic/vscode/.gitignore diff --git a/embedded-examples/satrs-example-stm32f3-disco/vscode/extensions.json b/embedded-examples/stm32f3-disco-rtic/vscode/extensions.json similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/vscode/extensions.json rename to embedded-examples/stm32f3-disco-rtic/vscode/extensions.json diff --git a/embedded-examples/satrs-example-stm32f3-disco/vscode/launch.json b/embedded-examples/stm32f3-disco-rtic/vscode/launch.json similarity index 90% rename from embedded-examples/satrs-example-stm32f3-disco/vscode/launch.json rename to embedded-examples/stm32f3-disco-rtic/vscode/launch.json index f982d67..53278b3 100644 --- a/embedded-examples/satrs-example-stm32f3-disco/vscode/launch.json +++ b/embedded-examples/stm32f3-disco-rtic/vscode/launch.json @@ -12,11 +12,11 @@ "chip": "STM32F303VCTx", "coreConfigs": [ { - "programBinary": "${workspaceFolder}/target/thumbv7em-none-eabihf/debug/satrs-example-stm32f3-disco", + "programBinary": "${workspaceFolder}/target/thumbv7em-none-eabihf/debug/satrs-stm32f3-disco-rtic", "rttEnabled": true, "svdFile": "STM32F303.svd" } ] } ] -} +} \ No newline at end of file diff --git a/embedded-examples/satrs-example-stm32f3-disco/vscode/openocd-helpers.tcl b/embedded-examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/vscode/openocd-helpers.tcl rename to embedded-examples/stm32f3-disco-rtic/vscode/openocd-helpers.tcl diff --git a/embedded-examples/satrs-example-stm32f3-disco/vscode/tasks.json b/embedded-examples/stm32f3-disco-rtic/vscode/tasks.json similarity index 100% rename from embedded-examples/satrs-example-stm32f3-disco/vscode/tasks.json rename to embedded-examples/stm32f3-disco-rtic/vscode/tasks.json