rust/sat-rs
rust/sat-rs
5
1
Fork 0
Code Issues 9 Pull Requests Projects Releases 22 Wiki Activity
3f78c200ad
sat-rs/README.md
Robin Mueller 3f78c200ad
Some checks are pending
Rust/sat-rs/pipeline/pr-main Build queued...
Details
improve phrasing
2024-05-22 19:09:43 +02:00

4.2 KiB
Raw Blame History

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-example-stm32f3-disco: Example of a simple example using low-level 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.

Flight Heritage

There is an active and continuous effort to get early flight heritage for the sat-rs library. Currently this library has the following flight heritage:

  • Submission as an OPS-SAT experiment which has also flown on the satellite. The application is strongly based on the sat-rs example application. You can find the repository of the experiment here.

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 crate with coverage. You can optionally supply the --open flag to open the coverage report in your webbrowser.