spacepackets/README.md
Robin Mueller 94ff4fbb51
Some checks failed
Rust/spacepackets/pipeline/pr-main There was a failure building this commit
Rust/spacepackets/pipeline/head There was a failure building this commit
added coverage section in README
2023-12-01 10:33:12 +01:00

2.8 KiB

Crates.io docs.rs ci

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

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

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.