spacepackets/README.md
Robin Mueller 3045a27d8c
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
just add support for everything
2024-03-29 13:42:02 +01:00

3.3 KiB

Crates.io docs.rs ci coverage

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:

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
  • 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 objects.

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.