Compare commits
47 Commits
v0.11.0-rc
...
main
Author | SHA1 | Date | |
---|---|---|---|
0e347b0e37 | |||
58dabb6f2f | |||
7fd65aa592 | |||
0024afc83e | |||
c48bd848d3 | |||
b8be9ae641 | |||
c2506dbba9 | |||
b842b9d11a | |||
374c034e92 | |||
791c7f6e02 | |||
8001938507 | |||
73ab7ff148 | |||
c59d01174f | |||
eb49bff0c9 | |||
af392d40d0 | |||
b78bfe2114 | |||
69a3b1d8f3 | |||
e7b3ba9575 | |||
c515535ccd | |||
95158a8cd2 | |||
8b1ccb0cd0 | |||
619b22e58f | |||
55222d92b3 | |||
8e1934e604 | |||
5f37978c56 | |||
97bbb14168 | |||
a65a98f43f | |||
e1a200e65b | |||
b55c7db3fc | |||
944bcf1320 | |||
8972dcbfc0 | |||
04b671fa6f | |||
533afc33fa | |||
50c56f6504 | |||
9e02e00d1a | |||
d8676ae711 | |||
9711159969 | |||
57adb619b3 | |||
fe52657d11 | |||
50b86939a1 | |||
179984f258 | |||
deb89362a4 | |||
4cd40f37ce | |||
bbd66a6a8b | |||
0115461bb5 | |||
ca90393d95 | |||
325e7d6ff3 |
115
.github/workflows/ci.yml
vendored
115
.github/workflows/ci.yml
vendored
|
@ -1,42 +1,39 @@
|
|||
on: [push]
|
||||
|
||||
name: ci
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
check:
|
||||
name: Check
|
||||
name: Check build
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --release
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo check --release
|
||||
|
||||
msrv:
|
||||
name: Check with MSRV
|
||||
test:
|
||||
name: Run Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 1.61.0
|
||||
override: true
|
||||
profile: minimal
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --release
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- name: Install nextest
|
||||
uses: taiki-e/install-action@nextest
|
||||
- run: cargo nextest run --all-features
|
||||
- run: cargo test --doc
|
||||
|
||||
msrv:
|
||||
name: Check MSRV
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@1.68.2
|
||||
- run: cargo check --release
|
||||
|
||||
cross-check:
|
||||
name: Check Cross
|
||||
name: Check Cross-Compilation
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
|
@ -44,70 +41,32 @@ jobs:
|
|||
- armv7-unknown-linux-gnueabihf
|
||||
- thumbv7em-none-eabihf
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
target: ${{ matrix.target }}
|
||||
override: true
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
use-cross: true
|
||||
command: check
|
||||
args: --release --target=${{ matrix.target }} --no-default-features
|
||||
targets: "armv7-unknown-linux-gnueabihf, thumbv7em-none-eabihf"
|
||||
- run: cargo check --release --target=${{matrix.target}} --no-default-features
|
||||
|
||||
fmt:
|
||||
name: Rustfmt
|
||||
name: Check formatting
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
override: true
|
||||
- run: rustup component add rustfmt
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: fmt
|
||||
args: --all -- --check
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo fmt --all -- --check
|
||||
|
||||
check-doc:
|
||||
docs:
|
||||
name: Check Documentation Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: nightly
|
||||
override: true
|
||||
profile: minimal
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: doc
|
||||
args: --all-features
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@nightly
|
||||
- run: cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]'
|
||||
|
||||
clippy:
|
||||
name: Clippy
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: stable
|
||||
- run: rustup component add clippy
|
||||
- uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: clippy
|
||||
args: -- -D warnings
|
||||
|
||||
ci:
|
||||
if: ${{ success() }}
|
||||
# all new jobs must be added to this list
|
||||
needs: [check, fmt, clippy]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: CI succeeded
|
||||
run: exit 0
|
||||
- uses: actions/checkout@v4
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo clippy -- -D warnings
|
||||
|
|
47
CHANGELOG.md
47
CHANGELOG.md
|
@ -8,6 +8,53 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||
|
||||
# [unreleased]
|
||||
|
||||
# [v0.11.2] 2024-05-19
|
||||
|
||||
- Bumped MSRV to 1.68.2
|
||||
|
||||
## Fixed
|
||||
|
||||
- Removed `defmt::Format` impl for `MetadataPduCreator` which seems to be problematic.
|
||||
|
||||
# [v0.11.1] 2024-04-22
|
||||
|
||||
## Fixed
|
||||
|
||||
- The default data length for for `SpHeader` constructors where the data field length is not
|
||||
specified is now 0.
|
||||
- The `SpHeader::new_from_fields` is public now.
|
||||
|
||||
## Added
|
||||
|
||||
- `SpHeader::to_vec` method.
|
||||
|
||||
# [v0.11.0] 2024-04-16
|
||||
|
||||
## Changed
|
||||
|
||||
- Moved `CCSDS_HEADER_LEN` constant to the crate root.
|
||||
|
||||
## Added
|
||||
|
||||
- Added `SpacePacketHeader` type alias for `SpHeader` type.
|
||||
|
||||
# [v0.11.0-rc.2] 2024-04-04
|
||||
|
||||
## Changed
|
||||
|
||||
- Renamed `PacketId` and `PacketSequenceCtrl` `new` method to `new_checked` and former
|
||||
`new_const` method to `new`.
|
||||
- Renamed `tc`, `tm`, `tc_unseg` and `tm_unseg` variants for `PacketId` and `SpHeader`
|
||||
to `new_for_tc_checked`, `new_for_tm_checked`, `new_for_unseg_tc_checked` and
|
||||
`new_for_unseg_tm_checked`.
|
||||
- `PusTmCreator` and `PusTcCreator` now expect a regular instance of `SpHeader` instead of
|
||||
a mutable reference.
|
||||
|
||||
## Added
|
||||
|
||||
- `SpHeader::new_from_apid` and `SpHeader::new_from_apid_checked` constructor.
|
||||
- `#[inline]` attribute for a lot of small functions.
|
||||
|
||||
# [v0.11.0-rc.1] 2024-04-03
|
||||
|
||||
Major API changes for the time API. If you are using the time API, it is strongly recommended
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
[package]
|
||||
name = "spacepackets"
|
||||
version = "0.11.0-rc.1"
|
||||
version = "0.11.2"
|
||||
edition = "2021"
|
||||
rust-version = "1.61"
|
||||
rust-version = "1.68.2"
|
||||
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
||||
description = "Generic implementations for various CCSDS and ECSS packet standards"
|
||||
homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"
|
||||
|
|
14
README.md
14
README.md
|
@ -29,10 +29,6 @@ Currently, this includes the following components:
|
|||
|
||||
`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||
|
||||
It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
||||
deserializing them with an appropriate `serde` provider like
|
||||
[`postcard`](https://github.com/jamesmunns/postcard).
|
||||
|
||||
## Default features
|
||||
|
||||
- [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
||||
|
@ -65,3 +61,13 @@ 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`](https://github.com/rust-lang/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.
|
||||
|
||||
```sh
|
||||
cargo +nightly miri nextest run --all-features
|
||||
```
|
||||
|
|
|
@ -15,7 +15,10 @@ RUN rustup install nightly && \
|
|||
rustup target add thumbv7em-none-eabihf armv7-unknown-linux-gnueabihf && \
|
||||
rustup component add rustfmt clippy llvm-tools-preview
|
||||
|
||||
# Get grcov
|
||||
RUN curl -sSL https://github.com/mozilla/grcov/releases/download/v0.8.19/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar -xj --directory /usr/local/bin
|
||||
# Get nextest
|
||||
RUN curl -LsSf https://get.nexte.st/latest/linux | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
|
||||
|
||||
# SSH stuff to allow deployment to doc server
|
||||
RUN adduser --uid 114 jenkins
|
||||
|
|
3
automation/Jenkinsfile
vendored
3
automation/Jenkinsfile
vendored
|
@ -31,7 +31,8 @@ pipeline {
|
|||
}
|
||||
stage('Test') {
|
||||
steps {
|
||||
sh 'cargo test --all-features'
|
||||
sh 'cargo nextest r --all-features'
|
||||
sh 'cargo test --doc'
|
||||
}
|
||||
}
|
||||
stage('Check with all features') {
|
||||
|
|
|
@ -8,7 +8,8 @@ Checklist for new releases
|
|||
2. Bump version specifier in `Cargo.toml`.
|
||||
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
|
||||
`unreleased` section.
|
||||
4. Run `cargo test --all-features` or `cargo nextest r --all-features`.
|
||||
4. Run `cargo test --all-features` or `cargo nextest r --all-features` together with
|
||||
`cargo test --doc`.
|
||||
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
|
||||
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
|
||||
targets.
|
||||
|
|
|
@ -62,6 +62,7 @@ pub(crate) fn generic_len_check_deserialization(
|
|||
}
|
||||
|
||||
impl<'data> Lv<'data> {
|
||||
#[inline]
|
||||
pub fn new(data: &[u8]) -> Result<Lv, TlvLvError> {
|
||||
if data.len() > u8::MAX as usize {
|
||||
return Err(TlvLvError::DataTooLarge(data.len()));
|
||||
|
@ -73,6 +74,7 @@ impl<'data> Lv<'data> {
|
|||
}
|
||||
|
||||
/// Creates a LV with an empty value field.
|
||||
#[inline]
|
||||
pub fn new_empty() -> Lv<'data> {
|
||||
Lv {
|
||||
data: &[],
|
||||
|
@ -82,6 +84,7 @@ impl<'data> Lv<'data> {
|
|||
|
||||
/// Helper function to build a string LV. This is especially useful for the file or directory
|
||||
/// path LVs
|
||||
#[inline]
|
||||
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvError> {
|
||||
Self::new(str_slice.as_bytes())
|
||||
}
|
||||
|
@ -89,37 +92,44 @@ impl<'data> Lv<'data> {
|
|||
/// Helper function to build a string LV. This is especially useful for the file or directory
|
||||
/// path LVs
|
||||
#[cfg(feature = "std")]
|
||||
#[inline]
|
||||
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvError> {
|
||||
Self::new(string.as_bytes())
|
||||
}
|
||||
|
||||
/// Returns the length of the value part, not including the length byte.
|
||||
#[inline]
|
||||
pub fn len_value(&self) -> usize {
|
||||
self.data.len()
|
||||
}
|
||||
|
||||
/// Returns the full raw length, including the length byte.
|
||||
#[inline]
|
||||
pub fn len_full(&self) -> usize {
|
||||
self.len_value() + 1
|
||||
}
|
||||
|
||||
/// Checks whether the value field is empty.
|
||||
#[inline]
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.data.len() == 0
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn value(&self) -> &[u8] {
|
||||
self.data
|
||||
}
|
||||
|
||||
/// If the LV was generated from a raw bytestream using [Self::from_bytes], the raw start
|
||||
/// of the LV can be retrieved with this method.
|
||||
#[inline]
|
||||
pub fn raw_data(&self) -> Option<&[u8]> {
|
||||
self.raw_data
|
||||
}
|
||||
|
||||
/// Convenience function to extract the value as a [str]. This is useful if the LV is
|
||||
/// known to contain a [str], for example being a file name.
|
||||
#[inline]
|
||||
pub fn value_as_str(&self) -> Option<Result<&'data str, Utf8Error>> {
|
||||
if self.is_empty() {
|
||||
return None;
|
||||
|
@ -135,6 +145,7 @@ impl<'data> Lv<'data> {
|
|||
}
|
||||
|
||||
/// Reads a LV from a raw buffer.
|
||||
#[inline]
|
||||
pub fn from_bytes(buf: &'data [u8]) -> Result<Lv<'data>, ByteConversionError> {
|
||||
generic_len_check_deserialization(buf, MIN_LV_LEN)?;
|
||||
Self::from_be_bytes_no_len_check(buf)
|
||||
|
@ -151,6 +162,7 @@ impl<'data> Lv<'data> {
|
|||
MIN_LV_LEN + self.data.len()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub(crate) fn from_be_bytes_no_len_check(
|
||||
buf: &'data [u8],
|
||||
) -> Result<Lv<'data>, ByteConversionError> {
|
||||
|
|
|
@ -56,7 +56,6 @@ pub fn build_metadata_opts_from_vec(
|
|||
/// This abstraction exposes a specialized API for creating metadata PDUs as specified in
|
||||
/// CFDP chapter 5.2.5.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||
pub struct MetadataPduCreator<'src_name, 'dest_name, 'opts> {
|
||||
pdu_header: PduHeader,
|
||||
metadata_params: MetadataGenericParams,
|
||||
|
|
|
@ -150,12 +150,14 @@ impl Error for PduError {
|
|||
}
|
||||
|
||||
impl From<ByteConversionError> for PduError {
|
||||
#[inline]
|
||||
fn from(value: ByteConversionError) -> Self {
|
||||
Self::ByteConversion(value)
|
||||
}
|
||||
}
|
||||
|
||||
impl From<TlvLvError> for PduError {
|
||||
#[inline]
|
||||
fn from(e: TlvLvError) -> Self {
|
||||
Self::TlvLvError(e)
|
||||
}
|
||||
|
@ -179,33 +181,42 @@ pub trait WritablePduPacket {
|
|||
pub trait CfdpPdu {
|
||||
fn pdu_header(&self) -> &PduHeader;
|
||||
|
||||
#[inline]
|
||||
fn source_id(&self) -> UnsignedByteField {
|
||||
self.pdu_header().common_pdu_conf().source_entity_id
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn dest_id(&self) -> UnsignedByteField {
|
||||
self.pdu_header().common_pdu_conf().dest_entity_id
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn transaction_seq_num(&self) -> UnsignedByteField {
|
||||
self.pdu_header().common_pdu_conf().transaction_seq_num
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn transmission_mode(&self) -> TransmissionMode {
|
||||
self.pdu_header().common_pdu_conf().trans_mode
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn direction(&self) -> Direction {
|
||||
self.pdu_header().common_pdu_conf().direction
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn crc_flag(&self) -> CrcFlag {
|
||||
self.pdu_header().common_pdu_conf().crc_flag
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn file_flag(&self) -> LargeFileFlag {
|
||||
self.pdu_header().common_pdu_conf().file_flag
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn pdu_type(&self) -> PduType {
|
||||
self.pdu_header().pdu_type()
|
||||
}
|
||||
|
@ -234,6 +245,7 @@ pub struct CommonPduConfig {
|
|||
|
||||
// TODO: Builder pattern might be applicable here..
|
||||
impl CommonPduConfig {
|
||||
#[inline]
|
||||
pub fn new(
|
||||
source_id: impl Into<UnsignedByteField>,
|
||||
dest_id: impl Into<UnsignedByteField>,
|
||||
|
@ -265,6 +277,7 @@ impl CommonPduConfig {
|
|||
})
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_with_byte_fields(
|
||||
source_id: impl Into<UnsignedByteField>,
|
||||
dest_id: impl Into<UnsignedByteField>,
|
||||
|
@ -281,10 +294,12 @@ impl CommonPduConfig {
|
|||
)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn source_id(&self) -> UnsignedByteField {
|
||||
self.source_entity_id
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn source_dest_id_check(
|
||||
source_id: impl Into<UnsignedByteField>,
|
||||
dest_id: impl Into<UnsignedByteField>,
|
||||
|
@ -307,6 +322,7 @@ impl CommonPduConfig {
|
|||
Ok((source_id, dest_id))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_source_and_dest_id(
|
||||
&mut self,
|
||||
source_id: impl Into<UnsignedByteField>,
|
||||
|
@ -318,6 +334,7 @@ impl CommonPduConfig {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn dest_id(&self) -> UnsignedByteField {
|
||||
self.dest_entity_id
|
||||
}
|
||||
|
@ -326,6 +343,7 @@ impl CommonPduConfig {
|
|||
impl Default for CommonPduConfig {
|
||||
/// The defaults for the source ID, destination ID and the transaction sequence number is the
|
||||
/// [UnsignedByteFieldU8] with an intitial value of 0
|
||||
#[inline]
|
||||
fn default() -> Self {
|
||||
// The new function can not fail for these input parameters.
|
||||
Self::new(
|
||||
|
@ -342,6 +360,7 @@ impl Default for CommonPduConfig {
|
|||
}
|
||||
|
||||
impl PartialEq for CommonPduConfig {
|
||||
#[inline]
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.source_entity_id.value() == other.source_entity_id.value()
|
||||
&& self.dest_entity_id.value() == other.dest_entity_id.value()
|
||||
|
@ -370,6 +389,7 @@ pub struct PduHeader {
|
|||
}
|
||||
|
||||
impl PduHeader {
|
||||
#[inline]
|
||||
pub fn new_for_file_data(
|
||||
pdu_conf: CommonPduConfig,
|
||||
pdu_datafield_len: u16,
|
||||
|
@ -385,6 +405,7 @@ impl PduHeader {
|
|||
)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||
Self::new_generic(
|
||||
PduType::FileData,
|
||||
|
@ -394,6 +415,7 @@ impl PduHeader {
|
|||
SegmentationControl::NoRecordBoundaryPreservation,
|
||||
)
|
||||
}
|
||||
#[inline]
|
||||
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||
Self::new_generic(
|
||||
PduType::FileDirective,
|
||||
|
@ -404,6 +426,7 @@ impl PduHeader {
|
|||
)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_generic(
|
||||
pdu_type: PduType,
|
||||
pdu_conf: CommonPduConfig,
|
||||
|
@ -421,6 +444,7 @@ impl PduHeader {
|
|||
}
|
||||
|
||||
/// Returns only the length of the PDU header when written to a raw buffer.
|
||||
#[inline]
|
||||
pub fn header_len(&self) -> usize {
|
||||
FIXED_HEADER_LEN
|
||||
+ self.pdu_conf.source_entity_id.size()
|
||||
|
@ -428,12 +452,14 @@ impl PduHeader {
|
|||
+ self.pdu_conf.dest_entity_id.size()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn pdu_datafield_len(&self) -> usize {
|
||||
self.pdu_datafield_len.into()
|
||||
}
|
||||
|
||||
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
|
||||
/// plus the PDU datafield length.
|
||||
#[inline]
|
||||
pub fn pdu_len(&self) -> usize {
|
||||
self.header_len() + self.pdu_datafield_len as usize
|
||||
}
|
||||
|
@ -606,10 +632,13 @@ impl PduHeader {
|
|||
current_idx,
|
||||
))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn pdu_type(&self) -> PduType {
|
||||
self.pdu_type
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
|
||||
&self.pdu_conf
|
||||
}
|
||||
|
@ -617,6 +646,8 @@ impl PduHeader {
|
|||
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
|
||||
self.seg_metadata_flag
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn seg_ctrl(&self) -> SegmentationControl {
|
||||
self.seg_ctrl
|
||||
}
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
//! Common definitions and helpers required to create PUS TMTC packets according to
|
||||
//! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/)
|
||||
//!
|
||||
//! You can find the PUS telecommand definitions in the [tc] module and ithe PUS telemetry definitions
|
||||
//! inside the [tm] module.
|
||||
//! You can find the PUS telecommand types in the [tc] module and the the PUS telemetry
|
||||
//! types inside the [tm] module.
|
||||
use crate::{ByteConversionError, CcsdsPacket, CRC_CCITT_FALSE};
|
||||
#[cfg(feature = "alloc")]
|
||||
use alloc::vec::Vec;
|
||||
|
@ -22,7 +22,6 @@ pub mod tm;
|
|||
pub mod verification;
|
||||
|
||||
pub type CrcType = u16;
|
||||
pub const CCSDS_HEADER_LEN: usize = size_of::<crate::zc::SpHeader>();
|
||||
|
||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
|
@ -246,7 +245,7 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
|||
crc16: u16,
|
||||
) -> Result<(), PusError> {
|
||||
verify_crc16_ccitt_false_from_raw(raw_data)
|
||||
.then(|| ())
|
||||
.then_some(())
|
||||
.ok_or(PusError::ChecksumFailure(crc16))
|
||||
}
|
||||
|
||||
|
@ -262,9 +261,13 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw(raw_data: &[u8]) -> bool {
|
|||
macro_rules! ccsds_impl {
|
||||
() => {
|
||||
delegate!(to self.sp_header {
|
||||
#[inline]
|
||||
fn ccsds_version(&self) -> u8;
|
||||
#[inline]
|
||||
fn packet_id(&self) -> crate::PacketId;
|
||||
#[inline]
|
||||
fn psc(&self) -> crate::PacketSequenceCtrl;
|
||||
#[inline]
|
||||
fn data_len(&self) -> u16;
|
||||
});
|
||||
}
|
||||
|
@ -273,8 +276,11 @@ macro_rules! ccsds_impl {
|
|||
macro_rules! sp_header_impls {
|
||||
() => {
|
||||
delegate!(to self.sp_header {
|
||||
#[inline]
|
||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||
#[inline]
|
||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||
#[inline]
|
||||
pub fn set_seq_flags(&mut self, seq_flag: SequenceFlags);
|
||||
});
|
||||
}
|
||||
|
|
|
@ -54,6 +54,7 @@ pub enum SchedStatus {
|
|||
}
|
||||
|
||||
impl From<bool> for SchedStatus {
|
||||
#[inline]
|
||||
fn from(value: bool) -> Self {
|
||||
if value {
|
||||
SchedStatus::Enabled
|
||||
|
|
102
src/ecss/tc.rs
102
src/ecss/tc.rs
|
@ -9,9 +9,11 @@
|
|||
//! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader};
|
||||
//!
|
||||
//! // Create a ping telecommand with no user application data
|
||||
//! let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||
//! let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
||||
//! let pus_tc = PusTcCreator::new_no_app_data(&mut sph, tc_header, true);
|
||||
//! let pus_tc = PusTcCreator::new_no_app_data(
|
||||
//! SpHeader::new_from_apid(0x02),
|
||||
//! PusTcSecondaryHeader::new_simple(17, 1),
|
||||
//! true
|
||||
//! );
|
||||
//! println!("{:?}", pus_tc);
|
||||
//! assert_eq!(pus_tc.service(), 17);
|
||||
//! assert_eq!(pus_tc.subservice(), 1);
|
||||
|
@ -111,22 +113,27 @@ pub mod zc {
|
|||
}
|
||||
|
||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion {
|
||||
PusVersion::try_from(self.version_ack >> 4 & 0b1111).unwrap_or(PusVersion::Invalid)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn ack_flags(&self) -> u8 {
|
||||
self.version_ack & 0b1111
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn service(&self) -> u8 {
|
||||
self.service
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8 {
|
||||
self.subservice
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn source_id(&self) -> u16 {
|
||||
self.source_id.get()
|
||||
}
|
||||
|
@ -155,22 +162,27 @@ pub struct PusTcSecondaryHeader {
|
|||
}
|
||||
|
||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion {
|
||||
self.version
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn ack_flags(&self) -> u8 {
|
||||
self.ack
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn service(&self) -> u8 {
|
||||
self.service
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8 {
|
||||
self.subservice
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn source_id(&self) -> u16 {
|
||||
self.source_id
|
||||
}
|
||||
|
@ -191,6 +203,7 @@ impl TryFrom<zc::PusTcSecondaryHeader> for PusTcSecondaryHeader {
|
|||
}
|
||||
|
||||
impl PusTcSecondaryHeader {
|
||||
#[inline]
|
||||
pub fn new_simple(service: u8, subservice: u8) -> Self {
|
||||
PusTcSecondaryHeader {
|
||||
service,
|
||||
|
@ -201,6 +214,7 @@ impl PusTcSecondaryHeader {
|
|||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new(service: u8, subservice: u8, ack: u8, source_id: u16) -> Self {
|
||||
PusTcSecondaryHeader {
|
||||
service,
|
||||
|
@ -223,35 +237,36 @@ impl PusTcSecondaryHeader {
|
|||
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||
pub struct PusTcCreator<'raw_data> {
|
||||
pub struct PusTcCreator<'app_data> {
|
||||
sp_header: SpHeader,
|
||||
pub sec_header: PusTcSecondaryHeader,
|
||||
app_data: &'raw_data [u8],
|
||||
app_data: &'app_data [u8],
|
||||
}
|
||||
|
||||
impl<'raw_data> PusTcCreator<'raw_data> {
|
||||
impl<'app_data> PusTcCreator<'app_data> {
|
||||
/// Generates a new struct instance.
|
||||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * `sp_header` - Space packet header information. The correct packet type will be set
|
||||
/// automatically
|
||||
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
||||
/// header flag are set correctly by the constructor.
|
||||
/// * `sec_header` - Information contained in the data field header, including the service
|
||||
/// and subservice type
|
||||
/// * `app_data` - Custom application data
|
||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
||||
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
||||
/// the correct value to this field manually
|
||||
#[inline]
|
||||
pub fn new(
|
||||
sp_header: &mut SpHeader,
|
||||
mut sp_header: SpHeader,
|
||||
sec_header: PusTcSecondaryHeader,
|
||||
app_data: &'raw_data [u8],
|
||||
app_data: &'app_data [u8],
|
||||
set_ccsds_len: bool,
|
||||
) -> Self {
|
||||
sp_header.set_packet_type(PacketType::Tc);
|
||||
sp_header.set_sec_header_flag();
|
||||
let mut pus_tc = Self {
|
||||
sp_header: *sp_header,
|
||||
sp_header,
|
||||
app_data,
|
||||
sec_header,
|
||||
};
|
||||
|
@ -263,11 +278,12 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
|||
|
||||
/// Simplified version of the [Self::new] function which allows to only specify service
|
||||
/// and subservice instead of the full PUS TC secondary header.
|
||||
#[inline]
|
||||
pub fn new_simple(
|
||||
sph: &mut SpHeader,
|
||||
sph: SpHeader,
|
||||
service: u8,
|
||||
subservice: u8,
|
||||
app_data: &'raw_data [u8],
|
||||
app_data: &'app_data [u8],
|
||||
set_ccsds_len: bool,
|
||||
) -> Self {
|
||||
Self::new(
|
||||
|
@ -278,18 +294,26 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
|||
)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_no_app_data(
|
||||
sp_header: &mut SpHeader,
|
||||
sp_header: SpHeader,
|
||||
sec_header: PusTcSecondaryHeader,
|
||||
set_ccsds_len: bool,
|
||||
) -> Self {
|
||||
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn sp_header(&self) -> &SpHeader {
|
||||
&self.sp_header
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn sp_header_mut(&mut self) -> &mut SpHeader {
|
||||
&mut self.sp_header
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
||||
if ack > 0b1111 {
|
||||
return false;
|
||||
|
@ -298,6 +322,7 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
|||
true
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_source_id(&mut self, source_id: u16) {
|
||||
self.sec_header.source_id = source_id;
|
||||
}
|
||||
|
@ -310,6 +335,7 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
|||
/// If this was not done or the application data is set or changed after construction,
|
||||
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
||||
/// is set correctly.
|
||||
#[inline]
|
||||
pub fn update_ccsds_data_len(&mut self) {
|
||||
self.sp_header.data_len =
|
||||
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
||||
|
@ -345,6 +371,7 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
|||
}
|
||||
|
||||
impl WritablePusPacket for PusTcCreator<'_> {
|
||||
#[inline]
|
||||
fn len_written(&self) -> usize {
|
||||
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
||||
}
|
||||
|
@ -385,15 +412,20 @@ impl CcsdsPacket for PusTcCreator<'_> {
|
|||
|
||||
impl PusPacket for PusTcCreator<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
});
|
||||
|
||||
#[inline]
|
||||
fn user_data(&self) -> &[u8] {
|
||||
self.app_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn crc16(&self) -> Option<u16> {
|
||||
Some(self.calc_own_crc16())
|
||||
}
|
||||
|
@ -401,10 +433,15 @@ impl PusPacket for PusTcCreator<'_> {
|
|||
|
||||
impl GenericPusTcSecondaryHeader for PusTcCreator<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
#[inline]
|
||||
fn source_id(&self) -> u16;
|
||||
#[inline]
|
||||
fn ack_flags(&self) -> u8;
|
||||
});
|
||||
}
|
||||
|
@ -482,24 +519,29 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
|||
Ok((pus_tc, total_len))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn app_data(&self) -> &[u8] {
|
||||
self.user_data()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn raw_data(&self) -> &[u8] {
|
||||
self.raw_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn len_packed(&self) -> usize {
|
||||
self.sp_header.total_len()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn sp_header(&self) -> &SpHeader {
|
||||
&self.sp_header
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for PusTcReader<'_> {
|
||||
#[inline]
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.raw_data == other.raw_data
|
||||
}
|
||||
|
@ -511,15 +553,20 @@ impl CcsdsPacket for PusTcReader<'_> {
|
|||
|
||||
impl PusPacket for PusTcReader<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
});
|
||||
|
||||
#[inline]
|
||||
fn user_data(&self) -> &[u8] {
|
||||
self.app_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn crc16(&self) -> Option<u16> {
|
||||
Some(self.crc16)
|
||||
}
|
||||
|
@ -527,10 +574,15 @@ impl PusPacket for PusTcReader<'_> {
|
|||
|
||||
impl GenericPusTcSecondaryHeader for PusTcReader<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
#[inline]
|
||||
fn source_id(&self) -> u16;
|
||||
#[inline]
|
||||
fn ack_flags(&self) -> u8;
|
||||
});
|
||||
}
|
||||
|
@ -568,19 +620,19 @@ mod tests {
|
|||
use postcard::{from_bytes, to_allocvec};
|
||||
|
||||
fn base_ping_tc_full_ctor() -> PusTcCreator<'static> {
|
||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
||||
PusTcCreator::new_no_app_data(&mut sph, tc_header, true)
|
||||
PusTcCreator::new_no_app_data(sph, tc_header, true)
|
||||
}
|
||||
|
||||
fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
|
||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||
PusTcCreator::new_simple(&mut sph, 17, 1, &[], true)
|
||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||
PusTcCreator::new_simple(sph, 17, 1, &[], true)
|
||||
}
|
||||
|
||||
fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
|
||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||
PusTcCreator::new_simple(&mut sph, 17, 1, app_data, true)
|
||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||
PusTcCreator::new_simple(sph, 17, 1, app_data, true)
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
@ -636,8 +688,8 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_update_func() {
|
||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||
let mut tc = PusTcCreator::new_simple(&mut sph, 17, 1, &[], false);
|
||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||
let mut tc = PusTcCreator::new_simple(sph, 17, 1, &[], false);
|
||||
assert_eq!(tc.data_len(), 0);
|
||||
tc.update_ccsds_data_len();
|
||||
assert_eq!(tc.data_len(), 6);
|
||||
|
@ -809,7 +861,8 @@ mod tests {
|
|||
if !has_user_data {
|
||||
assert!(tc.user_data().is_empty());
|
||||
}
|
||||
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||
let mut comp_header =
|
||||
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||
comp_header.set_sec_header_flag();
|
||||
assert_eq!(*tc.sp_header(), comp_header);
|
||||
}
|
||||
|
@ -820,7 +873,8 @@ mod tests {
|
|||
assert!(tc.user_data().is_empty());
|
||||
}
|
||||
assert_eq!(tc.len_packed(), exp_full_len);
|
||||
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||
let mut comp_header =
|
||||
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||
comp_header.set_sec_header_flag();
|
||||
assert_eq!(*tc.sp_header(), comp_header);
|
||||
}
|
||||
|
|
192
src/ecss/tm.rs
192
src/ecss/tm.rs
|
@ -1,5 +1,47 @@
|
|||
//! This module contains all components required to create a ECSS PUS C telemetry packets according
|
||||
//! to [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/).
|
||||
//!
|
||||
//! # Examples
|
||||
//!
|
||||
//! ```rust
|
||||
//! use spacepackets::time::TimeWriter;
|
||||
//! use spacepackets::time::cds::CdsTime;
|
||||
//! use spacepackets::{CcsdsPacket, SpHeader};
|
||||
//! use spacepackets::ecss::{PusPacket, WritablePusPacket};
|
||||
//! use spacepackets::ecss::tm::{PusTmCreator, PusTmReader, PusTmSecondaryHeader};
|
||||
//!
|
||||
//! let mut time_buf: [u8; 7] = [0; 7];
|
||||
//! let time_now = CdsTime::now_with_u16_days().expect("creating CDS timestamp failed");
|
||||
//! // This can definitely hold the timestamp, so it is okay to unwrap.
|
||||
//! time_now.write_to_bytes(&mut time_buf).unwrap();
|
||||
//!
|
||||
//! // Create a ping telemetry with no user source data
|
||||
//! let ping_tm = PusTmCreator::new_no_source_data(
|
||||
//! SpHeader::new_from_apid(0x02),
|
||||
//! PusTmSecondaryHeader::new_simple(17, 2, &time_buf),
|
||||
//! true
|
||||
//! );
|
||||
//! println!("{:?}", ping_tm);
|
||||
//! assert_eq!(ping_tm.service(), 17);
|
||||
//! assert_eq!(ping_tm.subservice(), 2);
|
||||
//! assert_eq!(ping_tm.apid(), 0x02);
|
||||
//!
|
||||
//! // Serialize TM into a raw buffer
|
||||
//! let mut test_buf: [u8; 32] = [0; 32];
|
||||
//! let written_size = ping_tm
|
||||
//! .write_to_bytes(test_buf.as_mut_slice())
|
||||
//! .expect("Error writing TC to buffer");
|
||||
//! assert_eq!(written_size, 22);
|
||||
//! println!("{:?}", &test_buf[0..written_size]);
|
||||
//!
|
||||
//! // Deserialize from the raw byte representation
|
||||
//! let (ping_tm_reader, read_size) = PusTmReader::new(&test_buf, 7).expect("Deserialization failed");
|
||||
//! assert_eq!(written_size, read_size);
|
||||
//! assert_eq!(ping_tm_reader.service(), 17);
|
||||
//! assert_eq!(ping_tm_reader.subservice(), 2);
|
||||
//! assert_eq!(ping_tm_reader.apid(), 0x02);
|
||||
//! assert_eq!(ping_tm_reader.timestamp(), &time_buf);
|
||||
//! ```
|
||||
use crate::ecss::{
|
||||
calc_pus_crc16, ccsds_impl, crc_from_raw_data, sp_header_impls, user_data_from_raw,
|
||||
verify_crc16_ccitt_false_from_raw_to_pus_error, CrcType, PusError, PusPacket, PusVersion,
|
||||
|
@ -86,27 +128,33 @@ pub mod zc {
|
|||
}
|
||||
|
||||
impl GenericPusTmSecondaryHeader for PusTmSecHeaderWithoutTimestamp {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion {
|
||||
PusVersion::try_from(self.pus_version_and_sc_time_ref_status >> 4 & 0b1111)
|
||||
.unwrap_or(PusVersion::Invalid)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn sc_time_ref_status(&self) -> u8 {
|
||||
self.pus_version_and_sc_time_ref_status & 0b1111
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn service(&self) -> u8 {
|
||||
self.service
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8 {
|
||||
self.subservice
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn msg_counter(&self) -> u16 {
|
||||
self.msg_counter.get()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn dest_id(&self) -> u16 {
|
||||
self.dest_id.get()
|
||||
}
|
||||
|
@ -123,25 +171,28 @@ pub struct PusTmSecondaryHeader<'stamp> {
|
|||
pub subservice: u8,
|
||||
pub msg_counter: u16,
|
||||
pub dest_id: u16,
|
||||
pub time_stamp: &'stamp [u8],
|
||||
pub timestamp: &'stamp [u8],
|
||||
}
|
||||
|
||||
impl<'stamp> PusTmSecondaryHeader<'stamp> {
|
||||
pub fn new_simple(service: u8, subservice: u8, time_stamp: &'stamp [u8]) -> Self {
|
||||
Self::new(service, subservice, 0, 0, time_stamp)
|
||||
#[inline]
|
||||
pub fn new_simple(service: u8, subservice: u8, timestamp: &'stamp [u8]) -> Self {
|
||||
Self::new(service, subservice, 0, 0, timestamp)
|
||||
}
|
||||
|
||||
/// Like [Self::new_simple] but without a timestamp.
|
||||
#[inline]
|
||||
pub fn new_simple_no_timestamp(service: u8, subservice: u8) -> Self {
|
||||
Self::new(service, subservice, 0, 0, &[])
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new(
|
||||
service: u8,
|
||||
subservice: u8,
|
||||
msg_counter: u16,
|
||||
dest_id: u16,
|
||||
time_stamp: &'stamp [u8],
|
||||
timestamp: &'stamp [u8],
|
||||
) -> Self {
|
||||
PusTmSecondaryHeader {
|
||||
pus_version: PusVersion::PusC,
|
||||
|
@ -150,32 +201,38 @@ impl<'stamp> PusTmSecondaryHeader<'stamp> {
|
|||
subservice,
|
||||
msg_counter,
|
||||
dest_id,
|
||||
time_stamp,
|
||||
timestamp,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl GenericPusTmSecondaryHeader for PusTmSecondaryHeader<'_> {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion {
|
||||
self.pus_version
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn sc_time_ref_status(&self) -> u8 {
|
||||
self.sc_time_ref_status
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn service(&self) -> u8 {
|
||||
self.service
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8 {
|
||||
self.subservice
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn msg_counter(&self) -> u16 {
|
||||
self.msg_counter
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn dest_id(&self) -> u16 {
|
||||
self.dest_id
|
||||
}
|
||||
|
@ -184,6 +241,7 @@ impl GenericPusTmSecondaryHeader for PusTmSecondaryHeader<'_> {
|
|||
impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice> {
|
||||
type Error = ();
|
||||
|
||||
#[inline]
|
||||
fn try_from(sec_header: zc::PusTmSecHeader<'slice>) -> Result<Self, Self::Error> {
|
||||
Ok(PusTmSecondaryHeader {
|
||||
pus_version: sec_header.zc_header.pus_version(),
|
||||
|
@ -192,7 +250,7 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
|
|||
subservice: sec_header.zc_header.subservice(),
|
||||
msg_counter: sec_header.zc_header.msg_counter(),
|
||||
dest_id: sec_header.zc_header.dest_id(),
|
||||
time_stamp: sec_header.timestamp,
|
||||
timestamp: sec_header.timestamp,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
@ -208,43 +266,45 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
|
|||
///
|
||||
/// # Lifetimes
|
||||
///
|
||||
/// * `'raw_data` - This is the lifetime of the user provided time stamp and source data.
|
||||
/// * `'time` - This is the lifetime of the user provided timestamp.
|
||||
/// * `'src_data` - This is the lifetime of the user provided source data.
|
||||
#[derive(Eq, Debug, Copy, Clone)]
|
||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||
pub struct PusTmCreator<'time, 'raw_data> {
|
||||
pub struct PusTmCreator<'time, 'src_data> {
|
||||
pub sp_header: SpHeader,
|
||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||
pub sec_header: PusTmSecondaryHeader<'time>,
|
||||
source_data: &'raw_data [u8],
|
||||
source_data: &'src_data [u8],
|
||||
/// If this is set to false, a manual call to [Self::calc_own_crc16] or
|
||||
/// [Self::update_packet_fields] is necessary for the serialized or cached CRC16 to be valid.
|
||||
pub calc_crc_on_serialization: bool,
|
||||
}
|
||||
|
||||
impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
||||
impl<'time, 'src_data> PusTmCreator<'time, 'src_data> {
|
||||
/// Generates a new struct instance.
|
||||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// * `sp_header` - Space packet header information. The correct packet type will be set
|
||||
/// automatically
|
||||
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
||||
/// header flag are set correctly by the constructor.
|
||||
/// * `sec_header` - Information contained in the secondary header, including the service
|
||||
/// and subservice type
|
||||
/// * `source_data` - Custom application data
|
||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
||||
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
||||
/// the correct value to this field manually
|
||||
#[inline]
|
||||
pub fn new(
|
||||
sp_header: &mut SpHeader,
|
||||
mut sp_header: SpHeader,
|
||||
sec_header: PusTmSecondaryHeader<'time>,
|
||||
source_data: &'raw_data [u8],
|
||||
source_data: &'src_data [u8],
|
||||
set_ccsds_len: bool,
|
||||
) -> Self {
|
||||
sp_header.set_packet_type(PacketType::Tm);
|
||||
sp_header.set_sec_header_flag();
|
||||
let mut pus_tm = Self {
|
||||
sp_header: *sp_header,
|
||||
sp_header,
|
||||
source_data,
|
||||
sec_header,
|
||||
calc_crc_on_serialization: true,
|
||||
|
@ -255,50 +315,52 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
pus_tm
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_simple(
|
||||
sp_header: &mut SpHeader,
|
||||
sp_header: SpHeader,
|
||||
service: u8,
|
||||
subservice: u8,
|
||||
time_provider: &impl TimeWriter,
|
||||
stamp_buf: &'time mut [u8],
|
||||
source_data: Option<&'raw_data [u8]>,
|
||||
source_data: &'src_data [u8],
|
||||
set_ccsds_len: bool,
|
||||
) -> Result<Self, TimestampError> {
|
||||
let stamp_size = time_provider.write_to_bytes(stamp_buf)?;
|
||||
let sec_header =
|
||||
PusTmSecondaryHeader::new_simple(service, subservice, &stamp_buf[0..stamp_size]);
|
||||
Ok(Self::new(
|
||||
sp_header,
|
||||
sec_header,
|
||||
source_data.unwrap_or(&[]),
|
||||
set_ccsds_len,
|
||||
))
|
||||
Ok(Self::new(sp_header, sec_header, source_data, set_ccsds_len))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_no_source_data(
|
||||
sp_header: &mut SpHeader,
|
||||
sp_header: SpHeader,
|
||||
sec_header: PusTmSecondaryHeader<'time>,
|
||||
set_ccsds_len: bool,
|
||||
) -> Self {
|
||||
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn timestamp(&self) -> &[u8] {
|
||||
self.sec_header.time_stamp
|
||||
self.sec_header.timestamp
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn source_data(&self) -> &[u8] {
|
||||
self.source_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_dest_id(&mut self, dest_id: u16) {
|
||||
self.sec_header.dest_id = dest_id;
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_msg_counter(&mut self, msg_counter: u16) {
|
||||
self.sec_header.msg_counter = msg_counter
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_sc_time_ref_status(&mut self, sc_time_ref_status: u8) {
|
||||
self.sec_header.sc_time_ref_status = sc_time_ref_status & 0b1111;
|
||||
}
|
||||
|
@ -310,6 +372,7 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
/// If this was not done or the time stamp or source data is set or changed after construction,
|
||||
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
||||
/// is set correctly
|
||||
#[inline]
|
||||
pub fn update_ccsds_data_len(&mut self) {
|
||||
self.sp_header.data_len =
|
||||
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
||||
|
@ -323,12 +386,13 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
digest.update(sph_zc.as_bytes());
|
||||
let pus_tc_header = zc::PusTmSecHeaderWithoutTimestamp::try_from(self.sec_header).unwrap();
|
||||
digest.update(pus_tc_header.as_bytes());
|
||||
digest.update(self.sec_header.time_stamp);
|
||||
digest.update(self.sec_header.timestamp);
|
||||
digest.update(self.source_data);
|
||||
digest.finalize()
|
||||
}
|
||||
|
||||
/// This helper function calls both [Self::update_ccsds_data_len] and [Self::calc_own_crc16]
|
||||
#[inline]
|
||||
pub fn update_packet_fields(&mut self) {
|
||||
self.update_ccsds_data_len();
|
||||
}
|
||||
|
@ -352,9 +416,9 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
.write_to_bytes(&mut slice[curr_idx..curr_idx + sec_header_len])
|
||||
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
||||
curr_idx += sec_header_len;
|
||||
slice[curr_idx..curr_idx + self.sec_header.time_stamp.len()]
|
||||
.copy_from_slice(self.sec_header.time_stamp);
|
||||
curr_idx += self.sec_header.time_stamp.len();
|
||||
slice[curr_idx..curr_idx + self.sec_header.timestamp.len()]
|
||||
.copy_from_slice(self.sec_header.timestamp);
|
||||
curr_idx += self.sec_header.timestamp.len();
|
||||
slice[curr_idx..curr_idx + self.source_data.len()].copy_from_slice(self.source_data);
|
||||
curr_idx += self.source_data.len();
|
||||
let mut digest = CRC_CCITT_FALSE.digest();
|
||||
|
@ -368,15 +432,14 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
#[cfg(feature = "alloc")]
|
||||
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> Result<usize, PusError> {
|
||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||
let mut appended_len =
|
||||
PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA + self.sec_header.time_stamp.len();
|
||||
let mut appended_len = PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA + self.sec_header.timestamp.len();
|
||||
appended_len += self.source_data.len();
|
||||
let start_idx = vec.len();
|
||||
vec.extend_from_slice(sph_zc.as_bytes());
|
||||
// The PUS version is hardcoded to PUS C
|
||||
let sec_header = zc::PusTmSecHeaderWithoutTimestamp::try_from(self.sec_header).unwrap();
|
||||
vec.extend_from_slice(sec_header.as_bytes());
|
||||
vec.extend_from_slice(self.sec_header.time_stamp);
|
||||
vec.extend_from_slice(self.sec_header.timestamp);
|
||||
vec.extend_from_slice(self.source_data);
|
||||
let mut digest = CRC_CCITT_FALSE.digest();
|
||||
digest.update(&vec[start_idx..start_idx + appended_len - 2]);
|
||||
|
@ -386,9 +449,10 @@ impl<'time, 'raw_data> PusTmCreator<'time, 'raw_data> {
|
|||
}
|
||||
|
||||
impl WritablePusPacket for PusTmCreator<'_, '_> {
|
||||
#[inline]
|
||||
fn len_written(&self) -> usize {
|
||||
PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA
|
||||
+ self.sec_header.time_stamp.len()
|
||||
+ self.sec_header.timestamp.len()
|
||||
+ self.source_data.len()
|
||||
}
|
||||
/// Write the raw PUS byte representation to a provided buffer.
|
||||
|
@ -411,15 +475,20 @@ impl CcsdsPacket for PusTmCreator<'_, '_> {
|
|||
|
||||
impl PusPacket for PusTmCreator<'_, '_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
});
|
||||
|
||||
#[inline]
|
||||
fn user_data(&self) -> &[u8] {
|
||||
self.source_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn crc16(&self) -> Option<u16> {
|
||||
Some(self.calc_own_crc16())
|
||||
}
|
||||
|
@ -427,11 +496,17 @@ impl PusPacket for PusTmCreator<'_, '_> {
|
|||
|
||||
impl GenericPusTmSecondaryHeader for PusTmCreator<'_, '_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
#[inline]
|
||||
fn dest_id(&self) -> u16;
|
||||
#[inline]
|
||||
fn msg_counter(&self) -> u16;
|
||||
#[inline]
|
||||
fn sc_time_ref_status(&self) -> u8;
|
||||
});
|
||||
}
|
||||
|
@ -518,19 +593,23 @@ impl<'raw_data> PusTmReader<'raw_data> {
|
|||
Ok((pus_tm, total_len))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn len_packed(&self) -> usize {
|
||||
self.sp_header.total_len()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn source_data(&self) -> &[u8] {
|
||||
self.user_data()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn timestamp(&self) -> &[u8] {
|
||||
self.sec_header.time_stamp
|
||||
self.sec_header.timestamp
|
||||
}
|
||||
|
||||
/// This function will return the slice [Self] was constructed from.
|
||||
#[inline]
|
||||
pub fn raw_data(&self) -> &[u8] {
|
||||
self.raw_data
|
||||
}
|
||||
|
@ -551,15 +630,20 @@ impl CcsdsPacket for PusTmReader<'_> {
|
|||
|
||||
impl PusPacket for PusTmReader<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
});
|
||||
|
||||
#[inline]
|
||||
fn user_data(&self) -> &[u8] {
|
||||
self.source_data
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn crc16(&self) -> Option<u16> {
|
||||
Some(self.crc16)
|
||||
}
|
||||
|
@ -567,11 +651,17 @@ impl PusPacket for PusTmReader<'_> {
|
|||
|
||||
impl GenericPusTmSecondaryHeader for PusTmReader<'_> {
|
||||
delegate!(to self.sec_header {
|
||||
#[inline]
|
||||
fn pus_version(&self) -> PusVersion;
|
||||
#[inline]
|
||||
fn service(&self) -> u8;
|
||||
#[inline]
|
||||
fn subservice(&self) -> u8;
|
||||
#[inline]
|
||||
fn dest_id(&self) -> u16;
|
||||
#[inline]
|
||||
fn msg_counter(&self) -> u16;
|
||||
#[inline]
|
||||
fn sc_time_ref_status(&self) -> u8;
|
||||
});
|
||||
}
|
||||
|
@ -633,6 +723,7 @@ impl<'raw> PusTmZeroCopyWriter<'raw> {
|
|||
|
||||
/// Set the sequence count. Returns false and does not update the value if the passed value
|
||||
/// exceeds [MAX_APID].
|
||||
#[inline]
|
||||
pub fn set_apid(&mut self, apid: u16) -> bool {
|
||||
if apid > MAX_APID {
|
||||
return false;
|
||||
|
@ -645,11 +736,13 @@ impl<'raw> PusTmZeroCopyWriter<'raw> {
|
|||
}
|
||||
|
||||
/// This function sets the message counter in the PUS TM secondary header.
|
||||
#[inline]
|
||||
pub fn set_msg_count(&mut self, msg_count: u16) {
|
||||
self.raw_tm[9..11].copy_from_slice(&msg_count.to_be_bytes());
|
||||
}
|
||||
|
||||
/// This function sets the destination ID in the PUS TM secondary header.
|
||||
#[inline]
|
||||
pub fn set_destination_id(&mut self, dest_id: u16) {
|
||||
self.raw_tm[11..13].copy_from_slice(&dest_id.to_be_bytes())
|
||||
}
|
||||
|
@ -674,6 +767,7 @@ impl<'raw> PusTmZeroCopyWriter<'raw> {
|
|||
|
||||
/// Set the sequence count. Returns false and does not update the value if the passed value
|
||||
/// exceeds [MAX_SEQ_COUNT].
|
||||
#[inline]
|
||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool {
|
||||
if seq_count > MAX_SEQ_COUNT {
|
||||
return false;
|
||||
|
@ -788,20 +882,20 @@ mod tests {
|
|||
const DUMMY_DATA: &[u8] = &[0, 1, 2];
|
||||
|
||||
fn base_ping_reply_full_ctor(timestamp: &[u8]) -> PusTmCreator {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let tm_header = PusTmSecondaryHeader::new_simple(17, 2, timestamp);
|
||||
PusTmCreator::new_no_source_data(&mut sph, tm_header, true)
|
||||
PusTmCreator::new_no_source_data(sph, tm_header, true)
|
||||
}
|
||||
fn ping_reply_with_data(timestamp: &[u8]) -> PusTmCreator {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let tm_header = PusTmSecondaryHeader::new_simple(17, 2, timestamp);
|
||||
PusTmCreator::new(&mut sph, tm_header, DUMMY_DATA, true)
|
||||
PusTmCreator::new(sph, tm_header, DUMMY_DATA, true)
|
||||
}
|
||||
|
||||
fn base_hk_reply<'a, 'b>(timestamp: &'a [u8], src_data: &'b [u8]) -> PusTmCreator<'a, 'b> {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let tc_header = PusTmSecondaryHeader::new_simple(3, 5, timestamp);
|
||||
PusTmCreator::new(&mut sph, tc_header, src_data, true)
|
||||
PusTmCreator::new(sph, tc_header, src_data, true)
|
||||
}
|
||||
|
||||
fn dummy_timestamp() -> &'static [u8] {
|
||||
|
@ -816,11 +910,11 @@ mod tests {
|
|||
}
|
||||
#[test]
|
||||
fn test_basic_simple_api() {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let time_provider = CdsTime::new_with_u16_days(0, 0);
|
||||
let mut stamp_buf: [u8; 8] = [0; 8];
|
||||
let pus_tm =
|
||||
PusTmCreator::new_simple(&mut sph, 17, 2, &time_provider, &mut stamp_buf, None, true)
|
||||
PusTmCreator::new_simple(sph, 17, 2, &time_provider, &mut stamp_buf, &[], true)
|
||||
.unwrap();
|
||||
verify_ping_reply(&pus_tm, false, 22, &[64, 0, 0, 0, 0, 0, 0]);
|
||||
}
|
||||
|
@ -917,9 +1011,9 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_manual_field_update() {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let tc_header = PusTmSecondaryHeader::new_simple(17, 2, dummy_timestamp());
|
||||
let mut tm = PusTmCreator::new_no_source_data(&mut sph, tc_header, false);
|
||||
let mut tm = PusTmCreator::new_no_source_data(sph, tc_header, false);
|
||||
tm.calc_crc_on_serialization = false;
|
||||
assert_eq!(tm.data_len(), 0x00);
|
||||
let mut buf: [u8; 32] = [0; 32];
|
||||
|
@ -1147,7 +1241,7 @@ mod tests {
|
|||
#[test]
|
||||
fn test_sec_header_without_stamp() {
|
||||
let sec_header = PusTmSecondaryHeader::new_simple_no_timestamp(17, 1);
|
||||
assert_eq!(sec_header.time_stamp, &[]);
|
||||
assert_eq!(sec_header.timestamp, &[]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
@ -1207,11 +1301,11 @@ mod tests {
|
|||
#[test]
|
||||
#[cfg(feature = "serde")]
|
||||
fn test_serialization_creator_serde() {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let time_provider = CdsTime::new_with_u16_days(0, 0);
|
||||
let mut stamp_buf: [u8; 8] = [0; 8];
|
||||
let pus_tm =
|
||||
PusTmCreator::new_simple(&mut sph, 17, 2, &time_provider, &mut stamp_buf, None, true)
|
||||
PusTmCreator::new_simple(sph, 17, 2, &time_provider, &mut stamp_buf, &[], true)
|
||||
.unwrap();
|
||||
|
||||
let output = to_allocvec(&pus_tm).unwrap();
|
||||
|
@ -1222,11 +1316,11 @@ mod tests {
|
|||
#[test]
|
||||
#[cfg(feature = "serde")]
|
||||
fn test_serialization_reader_serde() {
|
||||
let mut sph = SpHeader::tm_unseg(0x123, 0x234, 0).unwrap();
|
||||
let sph = SpHeader::new_for_unseg_tm_checked(0x123, 0x234, 0).unwrap();
|
||||
let time_provider = CdsTime::new_with_u16_days(0, 0);
|
||||
let mut stamp_buf: [u8; 8] = [0; 8];
|
||||
let pus_tm =
|
||||
PusTmCreator::new_simple(&mut sph, 17, 2, &time_provider, &mut stamp_buf, None, true)
|
||||
PusTmCreator::new_simple(sph, 17, 2, &time_provider, &mut stamp_buf, &[], true)
|
||||
.unwrap();
|
||||
let pus_tm_vec = pus_tm.to_vec().unwrap();
|
||||
let (tm_reader, _) = PusTmReader::new(&pus_tm_vec, time_provider.len_as_bytes()).unwrap();
|
||||
|
|
349
src/lib.rs
349
src/lib.rs
|
@ -22,10 +22,6 @@
|
|||
//!
|
||||
//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||
//!
|
||||
//! It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
||||
//! deserializing them with an appropriate `serde` provider like
|
||||
//! [`postcard`](https://github.com/jamesmunns/postcard).
|
||||
//!
|
||||
//! ### Default features
|
||||
//!
|
||||
//! - [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
||||
|
@ -52,7 +48,7 @@
|
|||
//!
|
||||
//! ```rust
|
||||
//! use spacepackets::SpHeader;
|
||||
//! let sp_header = SpHeader::tc_unseg(0x42, 12, 1).expect("Error creating CCSDS TC header");
|
||||
//! let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 12, 1).expect("error creating CCSDS TC header");
|
||||
//! println!("{:?}", sp_header);
|
||||
//! let mut ccsds_buf: [u8; 32] = [0; 32];
|
||||
//! sp_header.write_to_be_bytes(&mut ccsds_buf).expect("Writing CCSDS TC header failed");
|
||||
|
@ -65,7 +61,6 @@ extern crate alloc;
|
|||
#[cfg(any(feature = "std", test))]
|
||||
extern crate std;
|
||||
|
||||
use crate::ecss::CCSDS_HEADER_LEN;
|
||||
use core::{
|
||||
fmt::{Debug, Display, Formatter},
|
||||
hash::Hash,
|
||||
|
@ -88,6 +83,8 @@ mod private {
|
|||
pub trait Sealed {}
|
||||
}
|
||||
|
||||
pub const CCSDS_HEADER_LEN: usize = core::mem::size_of::<crate::zc::SpHeader>();
|
||||
|
||||
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard.
|
||||
pub const CRC_CCITT_FALSE: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_3740);
|
||||
|
||||
|
@ -207,18 +204,21 @@ pub struct PacketId {
|
|||
}
|
||||
|
||||
impl PartialEq for PacketId {
|
||||
#[inline]
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.raw().eq(&other.raw())
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialOrd for PacketId {
|
||||
#[inline]
|
||||
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
|
||||
Some(self.cmp(other))
|
||||
}
|
||||
}
|
||||
|
||||
impl Ord for PacketId {
|
||||
#[inline]
|
||||
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
|
||||
self.raw().cmp(&other.raw())
|
||||
}
|
||||
|
@ -232,6 +232,7 @@ impl Hash for PacketId {
|
|||
}
|
||||
|
||||
impl Default for PacketId {
|
||||
#[inline]
|
||||
fn default() -> Self {
|
||||
PacketId {
|
||||
ptype: PacketType::Tm,
|
||||
|
@ -242,23 +243,34 @@ impl Default for PacketId {
|
|||
}
|
||||
|
||||
impl PacketId {
|
||||
pub const fn const_tc(sec_header: bool, apid: u16) -> Self {
|
||||
Self::const_new(PacketType::Tc, sec_header, apid)
|
||||
}
|
||||
|
||||
pub const fn const_tm(sec_header: bool, apid: u16) -> Self {
|
||||
Self::const_new(PacketType::Tm, sec_header, apid)
|
||||
}
|
||||
|
||||
pub fn tc(sec_header: bool, apid: u16) -> Option<Self> {
|
||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||
/// Use the checked constructor variants to avoid panics.
|
||||
#[inline]
|
||||
pub const fn new_for_tc(sec_header: bool, apid: u16) -> Self {
|
||||
Self::new(PacketType::Tc, sec_header, apid)
|
||||
}
|
||||
|
||||
pub fn tm(sec_header: bool, apid: u16) -> Option<Self> {
|
||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||
/// Use the checked constructor variants to avoid panics.
|
||||
#[inline]
|
||||
pub const fn new_for_tm(sec_header: bool, apid: u16) -> Self {
|
||||
Self::new(PacketType::Tm, sec_header, apid)
|
||||
}
|
||||
|
||||
pub const fn const_new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
||||
#[inline]
|
||||
pub fn new_for_tc_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
||||
Self::new_checked(PacketType::Tc, sec_header, apid)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_for_tm_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
||||
Self::new_checked(PacketType::Tm, sec_header, apid)
|
||||
}
|
||||
|
||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||
/// Use the checked variants to avoid panics.
|
||||
#[inline]
|
||||
pub const fn new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
||||
if apid > MAX_APID {
|
||||
panic!("APID too large");
|
||||
}
|
||||
|
@ -269,16 +281,18 @@ impl PacketId {
|
|||
}
|
||||
}
|
||||
|
||||
pub fn new(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
||||
#[inline]
|
||||
pub fn new_checked(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
||||
if apid > MAX_APID {
|
||||
return None;
|
||||
}
|
||||
Some(PacketId::const_new(ptype, sec_header_flag, apid))
|
||||
Some(PacketId::new(ptype, sec_header_flag, apid))
|
||||
}
|
||||
|
||||
/// Set a new Application Process ID (APID). If the passed number is invalid, the APID will
|
||||
/// not be set and false will be returned. The maximum allowed value for the 11-bit field is
|
||||
/// 2047
|
||||
#[inline]
|
||||
pub fn set_apid(&mut self, apid: u16) -> bool {
|
||||
if apid > MAX_APID {
|
||||
return false;
|
||||
|
@ -287,6 +301,7 @@ impl PacketId {
|
|||
true
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn apid(&self) -> u16 {
|
||||
self.apid
|
||||
}
|
||||
|
@ -318,9 +333,10 @@ pub struct PacketSequenceCtrl {
|
|||
}
|
||||
|
||||
impl PacketSequenceCtrl {
|
||||
/// const variant of [PacketSequenceCtrl::new], but panics if the sequence count exceeds
|
||||
/// [MAX_SEQ_COUNT].
|
||||
pub const fn const_new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
||||
/// This constructor panics if the sequence count exceeds [MAX_SEQ_COUNT].
|
||||
/// Use [Self::new_checked] to avoid panics.
|
||||
#[inline]
|
||||
pub const fn new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
||||
if seq_count > MAX_SEQ_COUNT {
|
||||
panic!("Sequence count too large");
|
||||
}
|
||||
|
@ -331,18 +347,22 @@ impl PacketSequenceCtrl {
|
|||
}
|
||||
|
||||
/// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT].
|
||||
pub fn new(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
||||
#[inline]
|
||||
pub fn new_checked(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
||||
if seq_count > MAX_SEQ_COUNT {
|
||||
return None;
|
||||
}
|
||||
Some(PacketSequenceCtrl::const_new(seq_flags, seq_count))
|
||||
Some(PacketSequenceCtrl::new(seq_flags, seq_count))
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn raw(&self) -> u16 {
|
||||
((self.seq_flags as u16) << 14) | self.seq_count
|
||||
}
|
||||
|
||||
/// Set a new sequence count. If the passed number is invalid, the sequence count will not be
|
||||
/// set and false will be returned. The maximum allowed value for the 14-bit field is 16383.
|
||||
#[inline]
|
||||
pub fn set_seq_count(&mut self, ssc: u16) -> bool {
|
||||
if ssc > MAX_SEQ_COUNT {
|
||||
return false;
|
||||
|
@ -351,6 +371,7 @@ impl PacketSequenceCtrl {
|
|||
true
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn seq_count(&self) -> u16 {
|
||||
self.seq_count
|
||||
}
|
||||
|
@ -392,6 +413,7 @@ pub trait CcsdsPacket {
|
|||
/// Retrieve data length field
|
||||
fn data_len(&self) -> u16;
|
||||
/// Retrieve the total packet size based on the data length field
|
||||
#[inline]
|
||||
fn total_len(&self) -> usize {
|
||||
usize::from(self.data_len()) + CCSDS_HEADER_LEN + 1
|
||||
}
|
||||
|
@ -480,9 +502,12 @@ pub struct SpHeader {
|
|||
pub data_len: u16,
|
||||
}
|
||||
|
||||
pub type SpacePacketHeader = SpHeader;
|
||||
|
||||
impl Default for SpHeader {
|
||||
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented]. The data
|
||||
/// length field is set to 1, which denotes an empty space packets.
|
||||
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented] and the
|
||||
/// data length to 0.
|
||||
#[inline]
|
||||
fn default() -> Self {
|
||||
SpHeader {
|
||||
version: 0,
|
||||
|
@ -491,12 +516,13 @@ impl Default for SpHeader {
|
|||
seq_flags: SequenceFlags::Unsegmented,
|
||||
seq_count: 0,
|
||||
},
|
||||
data_len: 1,
|
||||
data_len: 0,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl SpHeader {
|
||||
#[inline]
|
||||
pub const fn new(packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16) -> Self {
|
||||
Self {
|
||||
version: 0,
|
||||
|
@ -506,9 +532,43 @@ impl SpHeader {
|
|||
}
|
||||
}
|
||||
|
||||
/// const variant of the [SpHeader::new_fron_single_fields] function. Panics if the passed
|
||||
/// APID exceeds [MAX_APID] or the passed packet sequence count exceeds [MAX_SEQ_COUNT].
|
||||
const fn const_new_from_single_fields(
|
||||
/// This constructor sets the sequence flag field to [SequenceFlags::Unsegmented] and the data
|
||||
/// length to 0.
|
||||
///
|
||||
/// This constructor will panic if the APID exceeds [MAX_APID].
|
||||
#[inline]
|
||||
pub const fn new_from_apid(apid: u16) -> Self {
|
||||
SpHeader {
|
||||
version: 0,
|
||||
packet_id: PacketId::new(PacketType::Tm, false, apid),
|
||||
psc: PacketSequenceCtrl {
|
||||
seq_flags: SequenceFlags::Unsegmented,
|
||||
seq_count: 0,
|
||||
},
|
||||
data_len: 0,
|
||||
}
|
||||
}
|
||||
|
||||
/// Checked variant of [Self::new_from_apid].
|
||||
#[inline]
|
||||
pub fn new_from_apid_checked(apid: u16) -> Option<Self> {
|
||||
Some(SpHeader {
|
||||
version: 0,
|
||||
packet_id: PacketId::new_checked(PacketType::Tm, false, apid)?,
|
||||
psc: PacketSequenceCtrl {
|
||||
seq_flags: SequenceFlags::Unsegmented,
|
||||
seq_count: 0,
|
||||
},
|
||||
data_len: 0,
|
||||
})
|
||||
}
|
||||
|
||||
/// This constructor panics if the passed APID exceeds [MAX_APID] or the passed packet sequence
|
||||
/// count exceeds [MAX_SEQ_COUNT].
|
||||
///
|
||||
/// The checked constructor variants can be used to avoid panics.
|
||||
#[inline]
|
||||
pub const fn new_from_fields(
|
||||
ptype: PacketType,
|
||||
sec_header: bool,
|
||||
apid: u16,
|
||||
|
@ -523,17 +583,20 @@ impl SpHeader {
|
|||
panic!("APID is too large");
|
||||
}
|
||||
Self {
|
||||
psc: PacketSequenceCtrl::const_new(seq_flags, seq_count),
|
||||
packet_id: PacketId::const_new(ptype, sec_header, apid),
|
||||
psc: PacketSequenceCtrl::new(seq_flags, seq_count),
|
||||
packet_id: PacketId::new(ptype, sec_header, apid),
|
||||
data_len,
|
||||
version: 0,
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a new Space Packet Header instance which can be used to create generic
|
||||
/// Space Packets. This will return [None] if the APID or sequence count argument
|
||||
/// Space Packets.
|
||||
///
|
||||
/// This will return [None] if the APID or sequence count argument
|
||||
/// exceed [MAX_APID] or [MAX_SEQ_COUNT] respectively. The version field is set to 0b000.
|
||||
pub fn new_from_single_fields(
|
||||
#[inline]
|
||||
pub fn new_from_fields_checked(
|
||||
ptype: PacketType,
|
||||
sec_header: bool,
|
||||
apid: u16,
|
||||
|
@ -544,56 +607,117 @@ impl SpHeader {
|
|||
if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
|
||||
return None;
|
||||
}
|
||||
Some(SpHeader::const_new_from_single_fields(
|
||||
Some(SpHeader::new_from_fields(
|
||||
ptype, sec_header, apid, seq_flags, seq_count, data_len,
|
||||
))
|
||||
}
|
||||
|
||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||
/// set accordingly. The secondary header flag field is set to false.
|
||||
pub fn tm(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::new_from_single_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||
#[inline]
|
||||
pub fn new_for_tm_checked(
|
||||
apid: u16,
|
||||
seq_flags: SequenceFlags,
|
||||
seq_count: u16,
|
||||
data_len: u16,
|
||||
) -> Option<Self> {
|
||||
Self::new_from_fields_checked(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||
/// set accordingly. The secondary header flag field is set to false.
|
||||
pub fn tc(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::new_from_single_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||
#[inline]
|
||||
pub fn new_for_tc_checked(
|
||||
apid: u16,
|
||||
seq_flags: SequenceFlags,
|
||||
seq_count: u16,
|
||||
data_len: u16,
|
||||
) -> Option<Self> {
|
||||
Self::new_from_fields_checked(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Variant of [SpHeader::tm] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||
pub fn tm_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
/// This is an unchecked constructor which can panic on invalid input.
|
||||
#[inline]
|
||||
pub const fn new_for_tm(
|
||||
apid: u16,
|
||||
seq_flags: SequenceFlags,
|
||||
seq_count: u16,
|
||||
data_len: u16,
|
||||
) -> Self {
|
||||
Self::new_from_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Variant of [SpHeader::tc] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||
pub fn tc_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
/// This is an unchecked constructor which can panic on invalid input.
|
||||
#[inline]
|
||||
pub const fn new_for_tc(
|
||||
apid: u16,
|
||||
seq_flags: SequenceFlags,
|
||||
seq_count: u16,
|
||||
data_len: u16,
|
||||
) -> Self {
|
||||
Self::new_from_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||
}
|
||||
|
||||
//noinspection RsTraitImplementation
|
||||
delegate!(to self.packet_id {
|
||||
/// Variant of [SpHeader::new_for_tm_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||
#[inline]
|
||||
pub fn new_for_unseg_tm_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::new_for_tm_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Variant of [SpHeader::new_for_tc_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||
#[inline]
|
||||
pub fn new_for_unseg_tc_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||
Self::new_for_tc_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Variant of [SpHeader::new_for_tc] which sets the sequence flag field to [SequenceFlags::Unsegmented].
|
||||
///
|
||||
/// This is an unchecked constructor which can panic on invalid input.
|
||||
#[inline]
|
||||
pub const fn new_for_unseg_tc(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
||||
Self::new_for_tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
}
|
||||
|
||||
/// Variant of [SpHeader::new_for_tm] which sets the sequence flag field to [SequenceFlags::Unsegmented].
|
||||
///
|
||||
/// This is an unchecked constructor which can panic on invalid input.
|
||||
#[inline]
|
||||
pub const fn new_for_unseg_tm(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
||||
Self::new_for_tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||
}
|
||||
|
||||
delegate! {
|
||||
to self.packet_id {
|
||||
/// Returns [false] and fails if the APID exceeds [MAX_APID]
|
||||
#[inline]
|
||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
delegate!(to self.psc {
|
||||
delegate! {
|
||||
to self.psc {
|
||||
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
|
||||
#[inline]
|
||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags) {
|
||||
self.psc.seq_flags = seq_flags;
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_sec_header_flag(&mut self) {
|
||||
self.packet_id.sec_header_flag = true;
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn clear_sec_header_flag(&mut self) {
|
||||
self.packet_id.sec_header_flag = false;
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_packet_type(&mut self, packet_type: PacketType) {
|
||||
self.packet_id.ptype = packet_type;
|
||||
}
|
||||
|
@ -631,6 +755,15 @@ impl SpHeader {
|
|||
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
||||
Ok(&mut buf[CCSDS_HEADER_LEN..])
|
||||
}
|
||||
|
||||
/// Create a vector containing the CCSDS header.
|
||||
#[cfg(feature = "alloc")]
|
||||
pub fn to_vec(&self) -> alloc::vec::Vec<u8> {
|
||||
let mut vec = alloc::vec![0; CCSDS_HEADER_LEN];
|
||||
// This can not fail.
|
||||
self.write_to_be_bytes(&mut vec[..]).unwrap();
|
||||
vec
|
||||
}
|
||||
}
|
||||
|
||||
impl CcsdsPacket for SpHeader {
|
||||
|
@ -656,6 +789,7 @@ impl CcsdsPacket for SpHeader {
|
|||
}
|
||||
|
||||
impl CcsdsPrimaryHeader for SpHeader {
|
||||
#[inline]
|
||||
fn from_composite_fields(
|
||||
packet_id: PacketId,
|
||||
psc: PacketSequenceCtrl,
|
||||
|
@ -723,9 +857,12 @@ pub mod zc {
|
|||
((self.version_packet_id.get() >> 13) as u8) & 0b111
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn packet_id(&self) -> PacketId {
|
||||
PacketId::from(self.packet_id_raw())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn psc(&self) -> PacketSequenceCtrl {
|
||||
PacketSequenceCtrl::from(self.psc_raw())
|
||||
}
|
||||
|
@ -735,10 +872,12 @@ pub mod zc {
|
|||
self.data_len.get()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn packet_id_raw(&self) -> u16 {
|
||||
self.version_packet_id.get() & (!VERSION_MASK)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn psc_raw(&self) -> u16 {
|
||||
self.psc.get()
|
||||
}
|
||||
|
@ -762,6 +901,8 @@ pub mod zc {
|
|||
pub(crate) mod tests {
|
||||
use std::collections::HashSet;
|
||||
|
||||
#[allow(unused_imports)]
|
||||
use crate::ByteConversionError;
|
||||
#[cfg(feature = "serde")]
|
||||
use crate::CcsdsPrimaryHeader;
|
||||
use crate::{
|
||||
|
@ -778,12 +919,12 @@ pub(crate) mod tests {
|
|||
use serde::{de::DeserializeOwned, Serialize};
|
||||
|
||||
const CONST_SP: SpHeader = SpHeader::new(
|
||||
PacketId::const_tc(true, 0x36),
|
||||
PacketSequenceCtrl::const_new(SequenceFlags::ContinuationSegment, 0x88),
|
||||
PacketId::new_for_tc(true, 0x36),
|
||||
PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 0x88),
|
||||
0x90,
|
||||
);
|
||||
|
||||
const PACKET_ID_TM: PacketId = PacketId::const_tm(true, 0x22);
|
||||
const PACKET_ID_TM: PacketId = PacketId::new_for_tm(true, 0x22);
|
||||
|
||||
#[cfg(feature = "serde")]
|
||||
pub(crate) fn generic_serde_test<T: Serialize + DeserializeOwned + PartialEq + Debug>(
|
||||
|
@ -795,11 +936,12 @@ pub(crate) mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[allow(clippy::assertions_on_constants)]
|
||||
fn verify_const_packet_id() {
|
||||
assert_eq!(PACKET_ID_TM.apid(), 0x22);
|
||||
assert!(PACKET_ID_TM.sec_header_flag);
|
||||
assert_eq!(PACKET_ID_TM.ptype, PacketType::Tm);
|
||||
let const_tc_id = PacketId::const_tc(true, 0x23);
|
||||
let const_tc_id = PacketId::new_for_tc(true, 0x23);
|
||||
assert_eq!(const_tc_id.ptype, PacketType::Tc);
|
||||
}
|
||||
|
||||
|
@ -813,27 +955,27 @@ pub(crate) mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_packet_id_ctors() {
|
||||
let packet_id = PacketId::new(PacketType::Tc, true, 0x1ff);
|
||||
let packet_id = PacketId::new_checked(PacketType::Tc, true, 0x1ff);
|
||||
assert!(packet_id.is_some());
|
||||
let packet_id = packet_id.unwrap();
|
||||
assert_eq!(packet_id.apid(), 0x1ff);
|
||||
assert_eq!(packet_id.ptype, PacketType::Tc);
|
||||
assert!(packet_id.sec_header_flag);
|
||||
let packet_id_tc = PacketId::tc(true, 0x1ff);
|
||||
let packet_id_tc = PacketId::new_for_tc_checked(true, 0x1ff);
|
||||
assert!(packet_id_tc.is_some());
|
||||
let packet_id_tc = packet_id_tc.unwrap();
|
||||
assert_eq!(packet_id_tc, packet_id);
|
||||
let packet_id_tm = PacketId::tm(true, 0x2ff);
|
||||
let packet_id_tm = PacketId::new_for_tm_checked(true, 0x2ff);
|
||||
assert!(packet_id_tm.is_some());
|
||||
let packet_id_tm = packet_id_tm.unwrap();
|
||||
assert_eq!(packet_id_tm.sec_header_flag, true);
|
||||
assert!(packet_id_tm.sec_header_flag);
|
||||
assert_eq!(packet_id_tm.ptype, PacketType::Tm);
|
||||
assert_eq!(packet_id_tm.apid, 0x2ff);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_const_sp_header() {
|
||||
assert_eq!(CONST_SP.sec_header_flag(), true);
|
||||
assert!(CONST_SP.sec_header_flag());
|
||||
assert_eq!(CONST_SP.apid(), 0x36);
|
||||
assert_eq!(
|
||||
CONST_SP.sequence_flags(),
|
||||
|
@ -874,7 +1016,7 @@ pub(crate) mod tests {
|
|||
#[test]
|
||||
fn test_packet_id() {
|
||||
let packet_id =
|
||||
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||
assert_eq!(packet_id.raw(), 0x0042);
|
||||
let packet_id_from_raw = PacketId::from(packet_id.raw());
|
||||
assert_eq!(
|
||||
|
@ -882,26 +1024,26 @@ pub(crate) mod tests {
|
|||
PacketType::Tm
|
||||
);
|
||||
assert_eq!(packet_id_from_raw, packet_id);
|
||||
let packet_id_from_new = PacketId::new(PacketType::Tm, false, 0x42).unwrap();
|
||||
let packet_id_from_new = PacketId::new_checked(PacketType::Tm, false, 0x42).unwrap();
|
||||
assert_eq!(packet_id_from_new, packet_id);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_invalid_packet_id() {
|
||||
let packet_id_invalid = PacketId::new(PacketType::Tc, true, 0xFFFF);
|
||||
let packet_id_invalid = PacketId::new_checked(PacketType::Tc, true, 0xFFFF);
|
||||
assert!(packet_id_invalid.is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_invalid_apid_setter() {
|
||||
let mut packet_id =
|
||||
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||
assert!(!packet_id.set_apid(0xffff));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_invalid_seq_count() {
|
||||
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
||||
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
||||
.expect("PSC creation failed");
|
||||
assert_eq!(psc.seq_count(), 77);
|
||||
assert!(!psc.set_seq_count(0xffff));
|
||||
|
@ -909,7 +1051,7 @@ pub(crate) mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_packet_seq_ctrl() {
|
||||
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
||||
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
||||
.expect("PSC creation failed");
|
||||
assert_eq!(psc.raw(), 77);
|
||||
let psc_from_raw = PacketSequenceCtrl::from(psc.raw());
|
||||
|
@ -918,16 +1060,18 @@ pub(crate) mod tests {
|
|||
assert!(!psc.set_seq_count(2u16.pow(15)));
|
||||
assert_eq!(psc.raw(), 77);
|
||||
|
||||
let psc_invalid = PacketSequenceCtrl::new(SequenceFlags::FirstSegment, 0xFFFF);
|
||||
let psc_invalid = PacketSequenceCtrl::new_checked(SequenceFlags::FirstSegment, 0xFFFF);
|
||||
assert!(psc_invalid.is_none());
|
||||
let psc_from_new = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77).unwrap();
|
||||
let psc_from_new =
|
||||
PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77).unwrap();
|
||||
assert_eq!(psc_from_new, psc);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg(feature = "serde")]
|
||||
fn test_serde_sph() {
|
||||
let sp_header = SpHeader::tc_unseg(0x42, 12, 0).expect("Error creating SP header");
|
||||
let sp_header =
|
||||
SpHeader::new_for_unseg_tc_checked(0x42, 12, 0).expect("Error creating SP header");
|
||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||
assert!(sp_header.is_tc());
|
||||
assert!(!sp_header.sec_header_flag());
|
||||
|
@ -949,7 +1093,8 @@ pub(crate) mod tests {
|
|||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||
assert_eq!(sp_header.data_len, 0);
|
||||
|
||||
let sp_header = SpHeader::tm_unseg(0x7, 22, 36).expect("Error creating SP header");
|
||||
let sp_header =
|
||||
SpHeader::new_for_unseg_tm_checked(0x7, 22, 36).expect("Error creating SP header");
|
||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||
assert!(sp_header.is_tm());
|
||||
assert!(!sp_header.sec_header_flag());
|
||||
|
@ -963,8 +1108,8 @@ pub(crate) mod tests {
|
|||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||
|
||||
let from_comp_fields = SpHeader::from_composite_fields(
|
||||
PacketId::new(PacketType::Tc, true, 0x42).unwrap(),
|
||||
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7).unwrap(),
|
||||
PacketId::new(PacketType::Tc, true, 0x42),
|
||||
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7),
|
||||
0,
|
||||
None,
|
||||
);
|
||||
|
@ -981,7 +1126,7 @@ pub(crate) mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_setters() {
|
||||
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
assert!(sp_header.is_some());
|
||||
let mut sp_header = sp_header.unwrap();
|
||||
sp_header.set_apid(0x12);
|
||||
|
@ -999,7 +1144,7 @@ pub(crate) mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_tc_ctor() {
|
||||
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
assert!(sp_header.is_some());
|
||||
let sp_header = sp_header.unwrap();
|
||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||
|
@ -1007,23 +1152,35 @@ pub(crate) mod tests {
|
|||
|
||||
#[test]
|
||||
fn test_tc_ctor_unseg() {
|
||||
let sp_header = SpHeader::tc_unseg(0x42, 25, 0);
|
||||
let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 25, 0);
|
||||
assert!(sp_header.is_some());
|
||||
let sp_header = sp_header.unwrap();
|
||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_tc_ctor_unseg_const() {
|
||||
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 0);
|
||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_tm_ctor() {
|
||||
let sp_header = SpHeader::tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
let sp_header = SpHeader::new_for_tm_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
assert!(sp_header.is_some());
|
||||
let sp_header = sp_header.unwrap();
|
||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_tm_ctor_const() {
|
||||
let sp_header = SpHeader::new_for_tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_tm_ctor_unseg() {
|
||||
let sp_header = SpHeader::tm_unseg(0x42, 25, 0);
|
||||
let sp_header = SpHeader::new_for_unseg_tm_checked(0x42, 25, 0);
|
||||
assert!(sp_header.is_some());
|
||||
let sp_header = sp_header.unwrap();
|
||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||
|
@ -1041,8 +1198,8 @@ pub(crate) mod tests {
|
|||
fn test_zc_sph() {
|
||||
use zerocopy::AsBytes;
|
||||
|
||||
let sp_header =
|
||||
SpHeader::tc_unseg(0x7FF, pow(2, 14) - 1, 0).expect("Error creating SP header");
|
||||
let sp_header = SpHeader::new_for_unseg_tc_checked(0x7FF, pow(2, 14) - 1, 0)
|
||||
.expect("Error creating SP header");
|
||||
assert_eq!(sp_header.ptype(), PacketType::Tc);
|
||||
assert_eq!(sp_header.apid(), 0x7FF);
|
||||
assert_eq!(sp_header.data_len(), 0);
|
||||
|
@ -1107,4 +1264,40 @@ pub(crate) mod tests {
|
|||
let mut id_set = HashSet::new();
|
||||
id_set.insert(PacketId::from(1_u16));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sp_header_from_apid() {
|
||||
let sp_header = SpHeader::new_from_apid(0x03);
|
||||
assert_eq!(sp_header.apid(), 0x03);
|
||||
assert_eq!(sp_header.data_len(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sp_header_from_apid_checked() {
|
||||
let sp_header = SpHeader::new_from_apid_checked(0x03).unwrap();
|
||||
assert_eq!(sp_header.apid(), 0x03);
|
||||
assert_eq!(sp_header.data_len(), 0);
|
||||
}
|
||||
|
||||
#[cfg(feature = "defmt")]
|
||||
fn is_defmt_format<T: defmt::Format>(_t: T) {}
|
||||
|
||||
#[test]
|
||||
#[cfg(feature = "defmt")]
|
||||
fn test_defmt_format() {
|
||||
is_defmt_format(ByteConversionError::ToSliceTooSmall {
|
||||
found: 1,
|
||||
expected: 2,
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_sp_header_as_vec() {
|
||||
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 1);
|
||||
let sp_header_as_vec = sp_header.to_vec();
|
||||
let sp_header_read_back = SpHeader::from_be_bytes(&sp_header_as_vec)
|
||||
.expect("Error reading back SP header")
|
||||
.0;
|
||||
assert_eq!(sp_header, sp_header_read_back);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -71,7 +71,19 @@ mod tests {
|
|||
use std::format;
|
||||
|
||||
#[test]
|
||||
fn test_ascii_timestamp_a_unterminated() {
|
||||
fn test_ascii_timestamp_a_unterminated_epoch() {
|
||||
let date = chrono::DateTime::UNIX_EPOCH;
|
||||
let stamp_formatter = generate_time_code_a(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
let t_sep = stamp.find('T');
|
||||
assert!(t_sep.is_some());
|
||||
assert_eq!(t_sep.unwrap(), 10);
|
||||
assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_ascii_timestamp_a_unterminated_now() {
|
||||
let date = Utc::now();
|
||||
let stamp_formatter = generate_time_code_a(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
|
@ -82,7 +94,24 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn test_ascii_timestamp_a_terminated() {
|
||||
fn test_ascii_timestamp_a_terminated_epoch() {
|
||||
let date = chrono::DateTime::UNIX_EPOCH;
|
||||
let stamp_formatter = generate_time_code_a_terminated(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
let t_sep = stamp.find('T');
|
||||
assert!(t_sep.is_some());
|
||||
assert_eq!(t_sep.unwrap(), 10);
|
||||
let z_terminator = stamp.find('Z');
|
||||
assert!(z_terminator.is_some());
|
||||
assert_eq!(
|
||||
z_terminator.unwrap(),
|
||||
FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1 - 1
|
||||
);
|
||||
assert_eq!(stamp.len(), FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1);
|
||||
}
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_ascii_timestamp_a_terminated_now() {
|
||||
let date = Utc::now();
|
||||
let stamp_formatter = generate_time_code_a_terminated(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
|
@ -99,7 +128,19 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn test_ascii_timestamp_b_unterminated() {
|
||||
fn test_ascii_timestamp_b_unterminated_epoch() {
|
||||
let date = chrono::DateTime::UNIX_EPOCH;
|
||||
let stamp_formatter = generate_time_code_b(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
let t_sep = stamp.find('T');
|
||||
assert!(t_sep.is_some());
|
||||
assert_eq!(t_sep.unwrap(), 8);
|
||||
assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_ascii_timestamp_b_unterminated_now() {
|
||||
let date = Utc::now();
|
||||
let stamp_formatter = generate_time_code_b(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
|
@ -110,7 +151,25 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn test_ascii_timestamp_b_terminated() {
|
||||
fn test_ascii_timestamp_b_terminated_epoch() {
|
||||
let date = chrono::DateTime::UNIX_EPOCH;
|
||||
let stamp_formatter = generate_time_code_b_terminated(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
let t_sep = stamp.find('T');
|
||||
assert!(t_sep.is_some());
|
||||
assert_eq!(t_sep.unwrap(), 8);
|
||||
let z_terminator = stamp.find('Z');
|
||||
assert!(z_terminator.is_some());
|
||||
assert_eq!(
|
||||
z_terminator.unwrap(),
|
||||
FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1 - 1
|
||||
);
|
||||
assert_eq!(stamp.len(), FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_ascii_timestamp_b_terminated_now() {
|
||||
let date = Utc::now();
|
||||
let stamp_formatter = generate_time_code_b_terminated(&date);
|
||||
let stamp = format!("{}", stamp_formatter);
|
||||
|
|
|
@ -145,6 +145,7 @@ pub fn length_of_day_segment_from_pfield(pfield: u8) -> LengthOfDaySegment {
|
|||
LengthOfDaySegment::Short16Bits
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn precision_from_pfield(pfield: u8) -> SubmillisPrecision {
|
||||
match pfield & 0b11 {
|
||||
0b01 => SubmillisPrecision::Microseconds,
|
||||
|
@ -272,24 +273,29 @@ impl ConversionFromUnix {
|
|||
}
|
||||
|
||||
impl CdsCommon for ConversionFromUnix {
|
||||
#[inline]
|
||||
fn submillis_precision(&self) -> SubmillisPrecision {
|
||||
self.submilis_prec
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn ms_of_day(&self) -> u32 {
|
||||
self.ms_of_day
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn ccsds_days_as_u32(&self) -> u32 {
|
||||
self.ccsds_days
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn submillis(&self) -> u32 {
|
||||
self.submillis
|
||||
}
|
||||
}
|
||||
|
||||
impl CdsConverter for ConversionFromUnix {
|
||||
#[inline]
|
||||
fn unix_days_seconds(&self) -> i64 {
|
||||
self.unix_days_seconds
|
||||
}
|
||||
|
@ -302,24 +308,31 @@ struct ConversionFromChronoDatetime {
|
|||
}
|
||||
|
||||
impl CdsCommon for ConversionFromChronoDatetime {
|
||||
#[inline]
|
||||
fn submillis_precision(&self) -> SubmillisPrecision {
|
||||
self.submillis_prec
|
||||
}
|
||||
|
||||
delegate! {
|
||||
to self.unix_conversion {
|
||||
#[inline]
|
||||
fn ms_of_day(&self) -> u32;
|
||||
#[inline]
|
||||
fn ccsds_days_as_u32(&self) -> u32;
|
||||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn submillis(&self) -> u32 {
|
||||
self.submillis
|
||||
}
|
||||
}
|
||||
|
||||
impl CdsConverter for ConversionFromChronoDatetime {
|
||||
delegate! {to self.unix_conversion { fn unix_days_seconds(&self) -> i64; }}
|
||||
delegate! {to self.unix_conversion {
|
||||
#[inline]
|
||||
fn unix_days_seconds(&self) -> i64;
|
||||
}}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
|
@ -1609,6 +1622,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_time_now() {
|
||||
let timestamp_now = CdsTime::now_with_u16_days().unwrap();
|
||||
let compare_stamp = chrono::Utc::now();
|
||||
|
@ -1616,6 +1630,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_time_now_us_prec() {
|
||||
let timestamp_now = CdsTime::now_with_u16_days_us_precision().unwrap();
|
||||
let compare_stamp = chrono::Utc::now();
|
||||
|
@ -1623,6 +1638,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_time_now_ps_prec() {
|
||||
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
||||
let compare_stamp = chrono::Utc::now();
|
||||
|
@ -1630,6 +1646,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_time_now_ps_prec_u16_days() {
|
||||
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
||||
let compare_stamp = chrono::Utc::now();
|
||||
|
@ -1637,6 +1654,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_time_now_ps_prec_u24_days() {
|
||||
let timestamp_now = CdsTime::now_with_u24_days_ps_precision().unwrap();
|
||||
let compare_stamp = chrono::Utc::now();
|
||||
|
@ -2293,6 +2311,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_update_from_now() {
|
||||
let mut stamp = CdsTime::new_with_u16_days(0, 0);
|
||||
let _ = stamp.update_from_now();
|
||||
|
@ -2308,6 +2327,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
#[cfg(feature = "serde")]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_serialization() {
|
||||
let stamp_now = CdsTime::now_with_u16_days().expect("Error retrieving time");
|
||||
let val = to_allocvec(&stamp_now).expect("Serializing timestamp failed");
|
||||
|
|
|
@ -177,6 +177,7 @@ pub struct FractionalPart {
|
|||
}
|
||||
|
||||
impl FractionalPart {
|
||||
#[inline]
|
||||
pub const fn new(resolution: FractionalResolution, counter: u32) -> Self {
|
||||
let div = fractional_res_to_div(resolution);
|
||||
assert!(counter <= div, "invalid counter for resolution");
|
||||
|
@ -187,15 +188,18 @@ impl FractionalPart {
|
|||
}
|
||||
|
||||
/// An empty fractional part for second resolution only.
|
||||
#[inline]
|
||||
pub const fn new_with_seconds_resolution() -> Self {
|
||||
Self::new(FractionalResolution::Seconds, 0)
|
||||
}
|
||||
|
||||
/// Helper method which simply calls [Self::new_with_seconds_resolution].
|
||||
#[inline]
|
||||
pub const fn new_empty() -> Self {
|
||||
Self::new_with_seconds_resolution()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_checked(resolution: FractionalResolution, counter: u32) -> Option<Self> {
|
||||
let div = fractional_res_to_div(resolution);
|
||||
if counter > div {
|
||||
|
@ -207,14 +211,17 @@ impl FractionalPart {
|
|||
})
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn resolution(&self) -> FractionalResolution {
|
||||
self.resolution
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn counter(&self) -> u32 {
|
||||
self.counter
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn no_fractional_part(&self) -> bool {
|
||||
self.resolution == FractionalResolution::Seconds
|
||||
}
|
||||
|
@ -285,6 +292,7 @@ pub struct CucTimeWithLeapSecs {
|
|||
}
|
||||
|
||||
impl CucTimeWithLeapSecs {
|
||||
#[inline]
|
||||
pub fn new(time: CucTime, leap_seconds: u32) -> Self {
|
||||
Self { time, leap_seconds }
|
||||
}
|
||||
|
@ -300,6 +308,7 @@ pub fn pfield_len(pfield: u8) -> usize {
|
|||
|
||||
impl CucTime {
|
||||
/// Create a time provider with a four byte counter and no fractional part.
|
||||
#[inline]
|
||||
pub fn new(counter: u32) -> Self {
|
||||
// These values are definitely valid, so it is okay to unwrap here.
|
||||
Self::new_generic(
|
||||
|
@ -310,11 +319,13 @@ impl CucTime {
|
|||
}
|
||||
|
||||
/// Like [CucTime::new] but allow to supply a fractional part as well.
|
||||
#[inline]
|
||||
pub fn new_with_fractions(counter: u32, fractions: FractionalPart) -> Result<Self, CucError> {
|
||||
Self::new_generic(WidthCounterPair(4, counter), fractions)
|
||||
}
|
||||
|
||||
/// Fractions with a resolution of ~ 4 ms
|
||||
#[inline]
|
||||
pub fn new_with_coarse_fractions(counter: u32, subsec_fractions: u8) -> Self {
|
||||
// These values are definitely valid, so it is okay to unwrap here.
|
||||
Self::new_generic(
|
||||
|
@ -328,6 +339,7 @@ impl CucTime {
|
|||
}
|
||||
|
||||
/// Fractions with a resolution of ~ 16 us
|
||||
#[inline]
|
||||
pub fn new_with_medium_fractions(counter: u32, subsec_fractions: u16) -> Self {
|
||||
// These values are definitely valid, so it is okay to unwrap here.
|
||||
Self::new_generic(
|
||||
|
@ -343,6 +355,7 @@ impl CucTime {
|
|||
/// Fractions with a resolution of ~ 60 ns. The fractional part value is limited by the
|
||||
/// 24 bits of the fractional field, so this function will fail with
|
||||
/// [CucError::InvalidFractions] if the fractional value exceeds the value.
|
||||
#[inline]
|
||||
pub fn new_with_fine_fractions(counter: u32, subsec_fractions: u32) -> Result<Self, CucError> {
|
||||
Self::new_generic(
|
||||
WidthCounterPair(4, counter),
|
||||
|
@ -457,6 +470,7 @@ impl CucTime {
|
|||
|
||||
/// Most generic constructor which allows full configurability for the counter and for the
|
||||
/// fractions.
|
||||
#[inline]
|
||||
pub fn new_generic(
|
||||
width_and_counter: WidthCounterPair,
|
||||
fractions: FractionalPart,
|
||||
|
@ -476,31 +490,38 @@ impl CucTime {
|
|||
})
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn ccsds_time_code(&self) -> CcsdsTimeCode {
|
||||
CcsdsTimeCode::CucCcsdsEpoch
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn width_counter_pair(&self) -> WidthCounterPair {
|
||||
self.counter
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn counter_width(&self) -> u8 {
|
||||
self.counter.0
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn counter(&self) -> u32 {
|
||||
self.counter.1
|
||||
}
|
||||
|
||||
/// Subsecond fractional part of the CUC time.
|
||||
#[inline]
|
||||
pub fn fractions(&self) -> FractionalPart {
|
||||
self.fractions
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn to_leap_sec_helper(&self, leap_seconds: u32) -> CucTimeWithLeapSecs {
|
||||
CucTimeWithLeapSecs::new(*self, leap_seconds)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn set_fractions(&mut self, fractions: FractionalPart) -> Result<(), CucError> {
|
||||
Self::verify_fractions_value(fractions)?;
|
||||
self.fractions = fractions;
|
||||
|
@ -510,6 +531,7 @@ impl CucTime {
|
|||
|
||||
/// Set a fractional resolution. Please note that this function will reset the fractional value
|
||||
/// to 0 if the resolution changes.
|
||||
#[inline]
|
||||
pub fn set_fractional_resolution(&mut self, res: FractionalResolution) {
|
||||
if res == FractionalResolution::Seconds {
|
||||
self.fractions = FractionalPart::new_with_seconds_resolution();
|
||||
|
@ -519,6 +541,7 @@ impl CucTime {
|
|||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn build_p_field(counter_width: u8, resolution: FractionalResolution) -> u8 {
|
||||
let mut pfield = P_FIELD_BASE;
|
||||
if !(1..=4).contains(&counter_width) {
|
||||
|
@ -538,6 +561,7 @@ impl CucTime {
|
|||
pfield
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn update_p_field_fractions(&mut self) {
|
||||
self.pfield &= !(0b11);
|
||||
self.pfield |= self.fractions.resolution() as u8;
|
||||
|
@ -582,6 +606,7 @@ impl CucTime {
|
|||
)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn len_packed_from_pfield(pfield: u8) -> usize {
|
||||
let mut base_len: usize = 1;
|
||||
base_len += Self::len_cntr_from_pfield(pfield) as usize;
|
||||
|
@ -590,6 +615,7 @@ impl CucTime {
|
|||
}
|
||||
|
||||
/// Verifies the raw width parameter.
|
||||
#[inline]
|
||||
fn verify_counter_width(width: u8) -> Result<(), CucError> {
|
||||
if width == 0 || width > 4 {
|
||||
return Err(CucError::InvalidCounterWidth(width));
|
||||
|
@ -597,6 +623,7 @@ impl CucTime {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn verify_fractions_value(val: FractionalPart) -> Result<(), CucError> {
|
||||
if val.counter > 2u32.pow((val.resolution as u32) * 8) - 1 {
|
||||
return Err(CucError::InvalidFractions {
|
||||
|
@ -607,10 +634,12 @@ impl CucTime {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn len_as_bytes(&self) -> usize {
|
||||
Self::len_packed_from_pfield(self.pfield)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subsec_nanos(&self) -> u32 {
|
||||
if self.fractions.resolution() == FractionalResolution::Seconds {
|
||||
return 0;
|
||||
|
@ -751,22 +780,27 @@ impl TimeWriter for CucTime {
|
|||
}
|
||||
|
||||
impl CcsdsTimeProvider for CucTimeWithLeapSecs {
|
||||
#[inline]
|
||||
fn len_as_bytes(&self) -> usize {
|
||||
self.time.len_as_bytes()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn p_field(&self) -> (usize, [u8; 2]) {
|
||||
(1, [self.time.pfield, 0])
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn ccdsd_time_code(&self) -> CcsdsTimeCode {
|
||||
self.time.ccsds_time_code()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn unix_secs(&self) -> i64 {
|
||||
self.time.unix_secs(self.leap_seconds)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn subsec_nanos(&self) -> u32 {
|
||||
self.time.subsec_nanos()
|
||||
}
|
||||
|
@ -913,6 +947,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_datetime_now() {
|
||||
let now = chrono::Utc::now();
|
||||
let cuc_now = CucTime::now(FractionalResolution::SixtyNs, LEAP_SECONDS);
|
||||
|
@ -1244,6 +1279,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn set_fract_resolution() {
|
||||
let mut stamp = CucTime::new(2000);
|
||||
stamp.set_fractional_resolution(FractionalResolution::SixtyNs);
|
||||
|
|
|
@ -166,6 +166,7 @@ pub fn seconds_since_epoch() -> f64 {
|
|||
///
|
||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||
#[inline]
|
||||
pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
||||
unix_days - DAYS_CCSDS_TO_UNIX as i64
|
||||
}
|
||||
|
@ -174,16 +175,19 @@ pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
|||
///
|
||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||
#[inline]
|
||||
pub const fn ccsds_to_unix_days(ccsds_days: i64) -> i64 {
|
||||
ccsds_days + DAYS_CCSDS_TO_UNIX as i64
|
||||
}
|
||||
|
||||
/// Similar to [unix_to_ccsds_days] but converts the epoch instead, which is the number of elpased
|
||||
/// seconds since the CCSDS and UNIX epoch times.
|
||||
#[inline]
|
||||
pub const fn unix_epoch_to_ccsds_epoch(unix_epoch: i64) -> i64 {
|
||||
unix_epoch - (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub const fn ccsds_epoch_to_unix_epoch(ccsds_epoch: i64) -> i64 {
|
||||
ccsds_epoch + (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||
}
|
||||
|
@ -547,6 +551,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_get_current_time() {
|
||||
let sec_floats = seconds_since_epoch();
|
||||
assert!(sec_floats > 0.0);
|
||||
|
@ -561,6 +566,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_ccsds_epoch() {
|
||||
let now = SystemTime::now()
|
||||
.duration_since(SystemTime::UNIX_EPOCH)
|
||||
|
@ -681,6 +687,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
#[cfg_attr(miri, ignore)]
|
||||
fn test_from_now() {
|
||||
let stamp_now = UnixTime::now().unwrap();
|
||||
let dt_now = stamp_now.chrono_date_time().unwrap();
|
||||
|
|
29
src/util.rs
29
src/util.rs
|
@ -15,10 +15,12 @@ pub trait ToBeBytes {
|
|||
impl ToBeBytes for () {
|
||||
type ByteArray = [u8; 0];
|
||||
|
||||
#[inline]
|
||||
fn written_len(&self) -> usize {
|
||||
0
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||
[]
|
||||
}
|
||||
|
@ -27,9 +29,12 @@ impl ToBeBytes for () {
|
|||
impl ToBeBytes for u8 {
|
||||
type ByteArray = [u8; 1];
|
||||
|
||||
#[inline]
|
||||
fn written_len(&self) -> usize {
|
||||
1
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||
u8::to_be_bytes(*self)
|
||||
}
|
||||
|
@ -38,9 +43,12 @@ impl ToBeBytes for u8 {
|
|||
impl ToBeBytes for u16 {
|
||||
type ByteArray = [u8; 2];
|
||||
|
||||
#[inline]
|
||||
fn written_len(&self) -> usize {
|
||||
2
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||
u16::to_be_bytes(*self)
|
||||
}
|
||||
|
@ -49,9 +57,12 @@ impl ToBeBytes for u16 {
|
|||
impl ToBeBytes for u32 {
|
||||
type ByteArray = [u8; 4];
|
||||
|
||||
#[inline]
|
||||
fn written_len(&self) -> usize {
|
||||
4
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||
u32::to_be_bytes(*self)
|
||||
}
|
||||
|
@ -60,9 +71,12 @@ impl ToBeBytes for u32 {
|
|||
impl ToBeBytes for u64 {
|
||||
type ByteArray = [u8; 8];
|
||||
|
||||
#[inline]
|
||||
fn written_len(&self) -> usize {
|
||||
8
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||
u64::to_be_bytes(*self)
|
||||
}
|
||||
|
@ -104,6 +118,7 @@ pub enum UnsignedByteFieldError {
|
|||
}
|
||||
|
||||
impl From<ByteConversionError> for UnsignedByteFieldError {
|
||||
#[inline]
|
||||
fn from(value: ByteConversionError) -> Self {
|
||||
Self::ByteConversionError(value)
|
||||
}
|
||||
|
@ -138,14 +153,17 @@ pub struct UnsignedByteField {
|
|||
}
|
||||
|
||||
impl UnsignedByteField {
|
||||
#[inline]
|
||||
pub const fn new(width: usize, value: u64) -> Self {
|
||||
Self { width, value }
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub const fn value_const(&self) -> u64 {
|
||||
self.value
|
||||
}
|
||||
|
||||
#[inline]
|
||||
pub fn new_from_be_bytes(width: usize, buf: &[u8]) -> Result<Self, UnsignedByteFieldError> {
|
||||
if width > buf.len() {
|
||||
return Err(ByteConversionError::FromSliceTooSmall {
|
||||
|
@ -178,10 +196,12 @@ impl UnsignedByteField {
|
|||
}
|
||||
|
||||
impl UnsignedEnum for UnsignedByteField {
|
||||
#[inline]
|
||||
fn size(&self) -> usize {
|
||||
self.width
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn value(&self) -> u64 {
|
||||
self.value_const()
|
||||
}
|
||||
|
@ -237,6 +257,7 @@ impl<TYPE: Copy + Into<u64>> GenericUnsignedByteField<TYPE> {
|
|||
}
|
||||
|
||||
impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
||||
#[inline]
|
||||
fn size(&self) -> usize {
|
||||
self.value.written_len()
|
||||
}
|
||||
|
@ -252,6 +273,7 @@ impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteFie
|
|||
Ok(self.value.written_len())
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn value(&self) -> u64 {
|
||||
self.value_typed().into()
|
||||
}
|
||||
|
@ -277,6 +299,7 @@ impl From<UnsignedByteFieldU8> for UnsignedByteField {
|
|||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
||||
type Error = UnsignedByteFieldError;
|
||||
|
||||
#[inline]
|
||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||
if value.width != 1 {
|
||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||
|
@ -289,6 +312,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
|||
}
|
||||
|
||||
impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
||||
#[inline]
|
||||
fn from(value: UnsignedByteFieldU16) -> Self {
|
||||
Self::new(2, value.value as u64)
|
||||
}
|
||||
|
@ -297,6 +321,7 @@ impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
|||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
||||
type Error = UnsignedByteFieldError;
|
||||
|
||||
#[inline]
|
||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||
if value.width != 2 {
|
||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||
|
@ -309,6 +334,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
|||
}
|
||||
|
||||
impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
||||
#[inline]
|
||||
fn from(value: UnsignedByteFieldU32) -> Self {
|
||||
Self::new(4, value.value as u64)
|
||||
}
|
||||
|
@ -317,6 +343,7 @@ impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
|||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
||||
type Error = UnsignedByteFieldError;
|
||||
|
||||
#[inline]
|
||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||
if value.width != 4 {
|
||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||
|
@ -329,6 +356,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
|||
}
|
||||
|
||||
impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
||||
#[inline]
|
||||
fn from(value: UnsignedByteFieldU64) -> Self {
|
||||
Self::new(8, value.value)
|
||||
}
|
||||
|
@ -337,6 +365,7 @@ impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
|||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU64 {
|
||||
type Error = UnsignedByteFieldError;
|
||||
|
||||
#[inline]
|
||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||
if value.width != 8 {
|
||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||
|
|
Loading…
Reference in New Issue
Block a user