rust/sat-rs
rust
/
sat-rs
5
1
Fork 0
Code Issues 11 Pull Requests 2 Projects Releases 19 Wiki Activity
sat-rs: A library to build on-board software for remote systems
921 Commits 5 Branches 19 Tags 10 MiB
Rust 96.8%
Python 2.8%
Dockerfile 0.2%
GDB 0.1%
Go to file
Robin Müller 3a6cd6712d
Rust/sat-rs/pipeline/head This commit looks good Details
Merge pull request 'MIB docs update' (#118) from mib-docs-update into main 
Reviewed-on: #118
 		2024-02-12 18:11:54 +01:00
.idea/runConfigurations remove spacepackets run configs 2023-01-25 23:04:32 +01:00
automation prepare sat-rs release 2024-02-12 16:55:19 +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 prep v0.1.1 2024-02-12 17:56:01 +01:00
satrs-book homepage link corrections 2024-02-12 17:29:48 +01:00
satrs-example Re-structure sat-rs 2024-02-12 15:51:37 +01:00
satrs-example-stm32f3-disco add license file 2023-01-25 22:20:12 +01:00
satrs-mib better documentation 2024-02-12 18:10:33 +01:00
satrs-shared homepage link corrections 2024-02-12 17:29:48 +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 Re-structure sat-rs 2024-02-12 15:51:37 +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 more link corrections 2024-02-12 17:34:16 +01:00
coverage.py add coverage 2023-12-01 22:21:12 +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 software projects 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: 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-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 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.