From 36d889a50420367c2fadc006bea64c2c442f8353 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 3 Jun 2024 15:31:43 +0200 Subject: [PATCH] update README and book --- README.md | 12 +++++++++--- satrs-book/src/introduction.md | 12 ++++++++---- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d3abe15..0aaaaba 100644 --- a/README.md +++ b/README.md @@ -37,13 +37,16 @@ This project currently contains following crates: * [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example): 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): + Mini-Simulator based on [asynchronix](https://github.com/asynchronics/asynchronix) 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/satrs-stm32f3-disco-rtic): +* [`satrs-stm32f3-disco-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-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/satrs-stm32h7-nucleo-rtic): +* [`satrs-stm32h-nucleo-rtic`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/embedded-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. @@ -69,7 +72,10 @@ Currently this library has the following flight heritage: [flown on the satellite](https://blogs.esa.int/rocketscience/2024/05/21/ops-sat-reentry-tomorrow-final-experiments-continue/). The application is strongly based on the sat-rs example application. You can find the repository of the experiment [here](https://egit.irs.uni-stuttgart.de/rust/ops-sat-rs). -- Development and use of a sat-rs-based [Demonstration Onboard Software](https://egit.irs.uni-stuttgart.de/rust/eurosim-obsw) alongside a Flight System Simulator in the context of a [Bachelors Thesis](https://www.researchgate.net/publication/380785984_Design_and_Development_of_a_Hardware-in-the-Loop_EuroSim_Demonstrator) at [Airbus Netherlands](https://www.airbusdefenceandspacenetherlands.nl/). +- Development and use of a sat-rs-based [demonstration on-board software](https://egit.irs.uni-stuttgart.de/rust/eurosim-obsw) + alongside a Flight System Simulator in the context of a + [Bachelors Thesis](https://www.researchgate.net/publication/380785984_Design_and_Development_of_a_Hardware-in-the-Loop_EuroSim_Demonstrator) + at [Airbus Netherlands](https://www.airbusdefenceandspacenetherlands.nl/). # Coverage diff --git a/satrs-book/src/introduction.md b/satrs-book/src/introduction.md index 1105000..906588f 100644 --- a/satrs-book/src/introduction.md +++ b/satrs-book/src/introduction.md @@ -5,10 +5,8 @@ This book is the primary information resource for the [sat-rs library](https://e in addition to the regular API documentation. It contains the following resources: 1. Architecture informations and consideration which would exceeds the scope of the regular API. -2. General information on how to build On-Board Software and how `sat-rs` can help to fulfill +2. General information on how to build on-board Software and how `sat-rs` can help to fulfill the unique requirements of writing software for remote systems. -2. A Getting-Started workshop where a small On-Board Software is built from scratch using - sat-rs components. # Introduction @@ -31,7 +29,9 @@ and [EIVE](https://www.irs.uni-stuttgart.de/en/research/satellitetechnology-and- The [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-example) 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 example application. The [`satrs-minisim`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-minisim) +applicatin complements the example application and can be used to simulate some physical devices +for the `satrs-example` device handlers. # Flight Heritage @@ -43,3 +43,7 @@ Currently this library has the following flight heritage: [flown on the satellite](https://blogs.esa.int/rocketscience/2024/05/21/ops-sat-reentry-tomorrow-final-experiments-continue/). The application is strongly based on the sat-rs example application. You can find the repository of the experiment [here](https://egit.irs.uni-stuttgart.de/rust/ops-sat-rs). +- Development and use of a sat-rs-based [demonstration on-board software](https://egit.irs.uni-stuttgart.de/rust/eurosim-obsw) + alongside a Flight System Simulator in the context of a + [Bachelors Thesis](https://www.researchgate.net/publication/380785984_Design_and_Development_of_a_Hardware-in-the-Loop_EuroSim_Demonstrator) + at [Airbus Netherlands](https://www.airbusdefenceandspacenetherlands.nl/).