Generic implementations for various CCSDS and ECSS packet standards in Rust

Go to file

Robin Müller f39ea2f793 All checks were successful Rust/spacepackets/pipeline/head This commit looks good Details Merge pull request 'improve the time API' (#64 ) from improve-time-api into main Reviewed-on: #64		2024-03-01 17:54:31 +01:00
.github/workflows	gitlab ci fix	2023-08-14 14:03:25 +02:00
.idea/runConfigurations	continue file data PDU	2023-05-30 15:36:02 +02:00
automation	fix deploy path	2023-12-12 11:48:00 +01:00
src	improve the time API	2024-02-27 15:59:04 +01:00
.gitignore	CHANGELOG clarification, gitignore comments	2023-01-26 21:00:32 +01:00
Cargo.toml	Extensions for UnsignedEnum trait	2024-02-17 13:24:25 +01:00
CHANGELOG.md	improve the time API	2024-02-27 15:59:04 +01:00
coverage.py	that reduced coverage again..	2023-12-06 01:12:33 +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	fix badge link for new website	2023-12-13 15:39:41 +01:00
release-checklist.md	update release checklist	2023-09-26 18:15:05 +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.

It also offers optional support for serde. This allows serializing and deserializing them with an appropriate serde provider like postcard.

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

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.