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
909 Commits 3 Branches 22 Tags 16 MiB
Rust 95.6%
Python 4.1%
Dockerfile 0.1%
GDB 0.1%
ffcc08632d
Go to file
Robin Mueller ffcc08632d
Some checks failed
Rust/sat-rs/pipeline/pr-main There was a failure building this commit
Details
add docs.rs metadata
2024-02-12 15:18:19 +01:00
.idea/runConfigurations remove spacepackets run configs 2023-01-25 23:04:32 +01:00
automation come on.. show it 2024-02-09 00:43:20 +01:00
images Update pool docs in sat-rs book 2024-02-10 11:57:19 +01:00
misc lets try this out 2023-09-06 21:56:48 +02:00
satrs use released satrs-shared version 2024-02-12 15:00:45 +01:00
satrs-book update pool docs 2024-02-10 12:54:13 +01:00
satrs-example added unittests for result code helper 2024-02-12 14:53:25 +01:00
satrs-example-stm32f3-disco add license file 2023-01-25 22:20:12 +01:00
satrs-mib fix all tests 2024-02-12 15:12:54 +01:00
satrs-shared add docs.rs metadata 2024-02-12 15:18:19 +01:00
.gitignore ignore Cargo.lock 2023-01-25 21:41:33 +01:00
.gitmodules remove spacepackets submodule 2023-01-25 20:37:28 +01:00
Cargo.toml restructure the crate 2024-02-12 14:27:22 +01:00
coverage.py add coverage 2023-12-01 22:21:12 +01: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 small link replacements 2024-02-07 18:17:14 +01:00

README.md

sat-rs

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

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-core: Core components of sat-rs.
  • 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-example-stm32f3-disco: Example of a simple example on-board software using sat-rs components on a bare-metal system with constrained resources.

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-core 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.