rust/sat-rs
rust/sat-rs
5
1
Fork 0
Code Issues 9 Pull Requests Projects Releases 22 Wiki Activity
sat-rs: A library to build on-board software for remote systems
1,104 Commits 3 Branches 22 Tags 16 MiB
Rust 95.6%
Python 4.1%
Dockerfile 0.1%
GDB 0.1%
1079445a07
Go to file
Robin Mueller 1079445a07
Some checks failed
Rust/sat-rs/pipeline/pr-main There was a failure building this commit
Details
introduce mem pool and heap
2024-05-21 19:43:54 +02:00
.github/workflows Introduce heapless memory pools 2024-05-21 18:31:19 +02:00
.idea/runConfigurations remove spacepackets run configs 2023-01-25 23:04:32 +01:00
automation Introduce heapless memory pools 2024-05-21 18:31:19 +02:00
embedded-examples introduce mem pool and heap 2024-05-21 19:43:54 +02:00
images update the satrs example graph 2024-05-10 17:03:46 +02:00
misc Major refactoring and update of PUS module 2024-04-04 15:18:53 +02:00
satrs introduce mem pool and heap 2024-05-21 19:43:54 +02:00
satrs-book cross ref docs 2024-05-13 15:36:09 +02:00
satrs-example Introduce heapless memory pools 2024-05-21 18:31:19 +02:00
satrs-mib prepare MIB release 2024-04-17 16:17:30 +02:00
satrs-minisim cargo fmt 2024-03-13 12:03:11 +01:00
satrs-shared prep next release candidate 2024-04-24 19:18:45 +02:00
.gitignore Merge branch 'main' into add-timestamp-to-sim-request 2024-04-09 17:27:57 +02:00
.gitmodules remove spacepackets submodule 2023-01-25 20:37:28 +01:00
Cargo.toml STM32H7 init commit 2024-05-19 21:44:09 +02:00
coverage.py Major refactoring and update of PUS module 2024-04-04 15:18:53 +02:00
LICENSE-APACHE add license files 2022-06-18 22:47:10 +02:00
NOTICE add credit 2023-09-06 21:58:56 +02:00
README.md better naming for embedded examples 2024-05-19 21:25:03 +02:00

README.md

sat-rs website sat-rs book Crates.io docs.rs

sat-rs

This is the repository of the sat-rs library. 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. You can find an overview of the project and the link to the more high-level sat-rs book at the IRS software projects website.

This is early-stage software. Important features are missing. New releases with breaking changes are released regularly, with all changes documented inside respective changelog files. You should only use this library if your are willing to work in this environment.

A lot of the architecture and general design considerations are based on the FSFW C++ framework which has flight heritage through the 2 missions FLP and EIVE.

Overview

This project currently contains following crates:

  • satrs-book: Primary information resource in addition to the API documentation, hosted here. It can be useful to read this first before delving into the example application and the API documentation.
  • satrs: Primary crate.
  • 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-mib: Components to build a mission information base from the on-board software directly.
  • satrs-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 framework on the STM32F3-Discovery device.
  • 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 framework on the STM32H743ZIT device.

Each project has its own CHANGELOG.md.

Related projects

In addition to the crates in this repository, the sat-rs project also maintains other libraries.

  • spacepackets: Basic ECSS and CCSDS packet protocol implementations. This repository is re-exported in the satrs crate.

Coverage

Coverage was generated using grcov. If you have not done so already, install the llvm-tools-preview:

rustup component add llvm-tools-preview
cargo install grcov --locked

After that, you can simply run coverage.py to test the satrs-core crate with coverage. You can optionally supply the --open flag to open the coverage report in your webbrowser.