sat-rs/README.md

38 lines
2.0 KiB
Markdown
Raw Normal View History

2023-07-11 23:02:14 +02:00
sat-rs
2022-06-09 12:52:01 +02:00
=========
2023-07-11 23:02:14 +02:00
This is the repository of the sat-rs framework. Its primary goal is to provide re-usable components
to write on-board software for remote systems like rovers or satellites. It is specifically written
for the special requirements for these systems.
2022-11-20 19:04:08 +01:00
2023-07-14 12:57:21 +02:00
A lot of the architecture and general design considerations are based on the
[FSFW](https://egit.irs.uni-stuttgart.de/fsfw/fsfw) C++ framework which has flight heritage
2023-07-14 12:58:14 +02:00
through the 2 missions [FLP](https://www.irs.uni-stuttgart.de/en/research/satellitetechnology-and-instruments/smallsatelliteprogram/flying-laptop/)
and [EIVE](https://www.irs.uni-stuttgart.de/en/research/satellitetechnology-and-instruments/smallsatelliteprogram/EIVE/).
2023-07-14 12:57:21 +02:00
2023-01-25 21:06:29 +01:00
# Overview
2023-01-11 10:41:52 +01:00
2023-01-25 21:06:29 +01:00
This project currently contains following crates:
* [`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core):
2023-01-25 21:27:50 +01:00
Core components of sat-rs.
2023-01-25 21:06:29 +01:00
* [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/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.
2023-01-25 21:32:39 +01:00
* [`satrs-mib`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-mib):
Components to build a mission information base from the on-board software directly.
2023-01-25 21:29:04 +01:00
* [`satrs-example-stm32f3-disco`](https://egit.irs.uni-stuttgart.de/rust/satrs-example-stm32f3-disco):
Example of a simple example on-board software using sat-rs components on a bare-metal system
2023-01-25 21:06:29 +01:00
with constrained resources.
2023-01-25 21:40:30 +01:00
Each project has its own `CHANGELOG.md`.
2023-01-25 21:06:29 +01:00
# Related projects
2023-01-25 23:08:25 +01:00
In addition to the crates in this repository, the sat-rs project also maintains other libraries.
2023-01-25 21:06:29 +01:00
* [`spacepackets`](https://egit.irs.uni-stuttgart.de/rust/spacepackets): Basic ECSS and CCSDS
2023-02-04 14:01:55 +01:00
packet protocol implementations. This repository is re-exported in the
2023-01-25 21:06:29 +01:00
[`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core)
crate.