rust/sat-rs
rust/sat-rs
5
1
Fork 0
Code Issues 9 Pull Requests 1 Projects Releases 21 Wiki Activity
sat-rs: A library to build on-board software for remote systems
1,017 Commits 3 Branches 21 Tags 16 MiB
Rust 95.5%
Python 4.1%
Dockerfile 0.2%
GDB 0.1%
7b37b76695
Go to file
Robin Mueller 7b37b76695
All checks were successful
Rust/sat-rs/pipeline/head This commit looks good
Details
prepare next release candidate
2024-04-17 17:19:38 +02: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 add mode tree graph 2024-02-16 17:42:44 +01:00
misc Major refactoring and update of PUS module 2024-04-04 15:18:53 +02:00
satrs prepare next release candidate 2024-04-17 17:19:38 +02:00
satrs-book Re-worked TMTC modules 2024-04-16 11:04:22 +02:00
satrs-example Re-worked TMTC modules 2024-04-16 11:04:22 +02:00
satrs-example-stm32f3-disco Update STM32F3 example 2024-04-04 18:21:30 +02:00
satrs-mib prepare MIB release 2024-04-17 16:17:30 +02:00
satrs-minisim new request/reponse API 2024-03-11 10:26:48 +01:00
satrs-shared small fix 2024-04-16 19:52:32 +02:00
.gitignore Major refactoring and update of PUS module 2024-04-04 15:18:53 +02:00
.gitmodules remove spacepackets submodule 2023-01-25 20:37:28 +01:00
Cargo.toml First version of asynchronix based mini simulator 2024-03-09 15:11:11 +01: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 Re-worked TMTC modules 2024-04-16 11:04:22 +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-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.

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.