Generic implementations for various CCSDS and ECSS packet standards in Rust

Go to file

Robin Müller 9aea3dba00 Merge pull request 'bump dependencies' (#113 ) from bump-dependencies into main Reviewed-on: #113		2024-11-08 11:14:04 +01:00
.github/workflows	Github MSRV version update	2024-08-19 10:44:33 +02:00
.idea/runConfigurations	continue file data PDU	2023-05-30 15:36:02 +02:00
automation	update documentation build	2024-06-25 16:07:07 +02:00
src	bump thiserror and zerocopy	2024-11-08 11:13:41 +01:00
.gitignore	CHANGELOG clarification, gitignore comments	2023-01-26 21:00:32 +01:00
Cargo.toml	bump thiserror and zerocopy	2024-11-08 11:13:41 +01:00
CHANGELOG.md	bump thiserror and zerocopy	2024-11-08 11:13:41 +01:00
coverage.py	that reduced coverage again..	2023-12-06 01:12:33 +01:00
docs.sh	docs fixes	2024-11-04 11:42:51 +01:00
LICENSE-APACHE	Init spacepackets crate	2022-06-18 22:48:51 +02:00
NOTICE	update NOTICE file	2023-01-24 11:26:47 +01:00
README.md	add miri chapter in README	2024-05-14 15:37:20 +02:00
release-checklist.md	update documentation build	2024-06-25 16:07:07 +02:00

README.md

ECSS and CCSDS Spacepackets

This package contains generic implementations for various CCSDS (Consultative Committee for Space Data Systems) and ECSS (European Cooperation for Space Standardization) packet standards.

Currently, this includes the following components:

Space Packet implementation according to CCSDS Blue Book 133.0-B-2
CCSDS File Delivery Protocol (CFDP) packet implementations according to CCSDS Blue Book 727.0-B-5
PUS Telecommand and PUS Telemetry implementation according to the ECSS-E-ST-70-41C standard.
CUC (CCSDS Unsegmented Time Code) implementation according to CCSDS 301.0-B-4 3.2
CDS (CCSDS Day Segmented Time Code) implementation according to CCSDS 301.0-B-4 3.3
Some helper types to support ASCII timecodes as specified in CCSDS 301.0-B-4 3.5

Features

spacepackets supports various runtime environments and is also suitable for no_std environments.

Default features

std: Enables functionality relying on the standard library.
alloc: Enables features which operate on containers like alloc::vec::Vec. Enabled by the std feature.

Optional Features

serde: Adds serde support for most types by adding Serialize and Deserialize derives
chrono: Add basic support for the chrono time library.
timelib: Add basic support for the time time library.
defmt: Add support for the defmt by adding the defmt::Format derive on many types.

Examples

You can check the documentation of individual modules for various usage examples.

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

Miri

You can run the miri tool on this library to check for undefined behaviour (UB). This library does not use use any unsafe code blocks, but miri could still catch UB from used libraries.

cargo +nightly miri nextest run --all-features