bump version

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.2.0] 13.09.2022
+
 ## Added
 
 - Basic support for ECSS enumeration types for u8, u16, u32 and u64
@@ -15,6 +17,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Changed
 
 - Better names for generic error enumerations: `PacketError` renamed to `ByteConversionError`
+- CCSDS module: `ssc` abbreviations fully replaced by better name `seq_count`
+- Time module: `CcsdsTimeProvider::date_time` now has `Option<DateTime<Utc>>` as
+  a returnvalue instead of `DateTime<Utc>`
+- `PusTc` and `PusTm`: `new_from_raw_slice` renamed to simpler `from_bytes`
 
 # [v0.1.0] 16.08.2022
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spacepackets"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 description = "Generic implementations for various CCSDS and ECSS packet standards"

README.md

@@ -20,11 +20,9 @@ Currently, this includes the following components:
  
 # Features
 
-`spacepackets` supports various runtime environments and is also suitable
-for suitable for `no_std` environments. It has several features which may be enabled
-for disabled.
+`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
 
-It also offers support for [`serde`](https://serde.rs/). The Space Paccket, PUS TM and TC
+It offers support for [`serde`](https://serde.rs/). The Space Packet, PUS TM and TC
 implementations derive the `serde` `Serialize` and `Deserialize` trait. This allows serializing and
 deserializing them with an appropriate `serde` provider like
 [`postcard`](https://github.com/jamesmunns/postcard).
@@ -35,3 +33,8 @@ Default features:
  - [`alloc`](https://doc.rust-lang.org/alloc/): Enables features which operate on containers
    like [`alloc::vec::Vec`](https://doc.rust-lang.org/beta/alloc/vec/struct.Vec.html).
    Enabled by the `std` feature.
+
+# Examples
+
+You can check the [documentation](https://docs.rs/spacepackets) of individual modules for various
+usage examples.

src/ecss.rs

@@ -33,6 +33,22 @@ impl TryFrom<u8> for PusVersion {
     }
 }
 
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub enum PacketTypeCodes {
+    Boolean = 1,
+    Enumerated = 2,
+    UnsignedInt = 3,
+    SignedInt = 4,
+    Real = 5,
+    BitString = 6,
+    OctetString = 7,
+    CharString = 8,
+    AbsoluteTime = 9,
+    RelativeTime = 10,
+    Deduced = 11,
+    Packet = 12,
+}
+
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum PusError {
     VersionNotSupported(PusVersion),
@@ -41,7 +57,13 @@ pub enum PusError {
     NoRawData,
     /// CRC16 needs to be calculated first
     CrcCalculationMissing,
-    PacketError(ByteConversionError),
+    ByteConversionError(ByteConversionError),
+}
+
+impl From<ByteConversionError> for PusError {
+    fn from(e: ByteConversionError) -> Self {
+        PusError::ByteConversionError(e)
+    }
 }
 
 pub trait PusPacket: CcsdsPacket {
@@ -136,7 +158,12 @@ macro_rules! sp_header_impls {
 pub(crate) use ccsds_impl;
 pub(crate) use sp_header_impls;
 
+/// Generic trait for ECSS enumeration which consist of a PFC field denoting their length
+/// and an unsigned value. The trait makes no assumptions about the actual type of the unsigned
+/// value and only requires implementors to implement a function which writes the enumeration into
+/// a raw byte format.
 pub trait EcssEnumeration {
+    /// Packet Format Code, which denotes the number of bits of the enumeration
     fn pfc(&self) -> u8;
     fn byte_width(&self) -> usize {
         (self.pfc() / 8) as usize
@@ -186,6 +213,10 @@ pub struct GenericEcssEnumWrapper<TYPE> {
 }
 
 impl<TYPE> GenericEcssEnumWrapper<TYPE> {
+    pub const fn ptc() -> PacketTypeCodes {
+        PacketTypeCodes::Enumerated
+    }
+
     pub fn new(val: TYPE) -> Self {
         Self { val }
     }

src/lib.rs

@@ -14,11 +14,9 @@
 //!
 //! ## Features
 //!
-//! `spacepackets` supports various runtime environments and is also suitable
-//! for suitable for `no_std` environments. It has several features which may be enabled
-//! for disabled.
+//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
 //!
-//! It also offers support for [`serde`](https://serde.rs/). The Space Paccket, PUS TM and TC
+//! It also offers support for [`serde`](https://serde.rs/). The Space Packet, PUS TM and TC
 //! implementations derive the `serde` `Serialize` and `Deserialize` trait. This allows serializing and
 //! deserializing them with an appropriate `serde` provider like
 //! [`postcard`](https://github.com/jamesmunns/postcard).
@@ -60,6 +58,7 @@ pub mod time;
 pub mod tm;
 
 pub const MAX_APID: u16 = 2u16.pow(11) - 1;
+pub const MAX_SEQ_COUNT: u16 = 2u16.pow(14) - 1;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub struct SizeMissmatch {
@@ -177,12 +176,13 @@ pub struct PacketSequenceCtrl {
 }
 
 impl PacketSequenceCtrl {
-    pub fn new(seq_flags: SequenceFlags, ssc: u16) -> Option<PacketSequenceCtrl> {
+    /// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT]
+    pub fn new(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
         let mut psc = PacketSequenceCtrl {
             seq_flags,
             seq_count: 0,
         };
-        psc.set_seq_count(ssc).then(|| psc)
+        psc.set_seq_count(seq_count).then(|| psc)
     }
     pub fn raw(&self) -> u16 {
         ((self.seq_flags as u16) << 14) | self.seq_count
@@ -191,14 +191,14 @@ impl PacketSequenceCtrl {
     /// 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
     pub fn set_seq_count(&mut self, ssc: u16) -> bool {
-        if ssc > 2u16.pow(14) - 1 {
+        if ssc > MAX_SEQ_COUNT {
             return false;
         }
         self.seq_count = ssc;
         true
     }
 
-    pub fn ssc(&self) -> u16 {
+    pub fn seq_count(&self) -> u16 {
         self.seq_count
     }
 }
@@ -323,6 +323,7 @@ pub struct SpHeader {
     pub psc: PacketSequenceCtrl,
     pub data_len: u16,
 }
+
 impl Default for SpHeader {
     fn default() -> Self {
         SpHeader {
@@ -341,29 +342,36 @@ impl Default for SpHeader {
     }
 }
 impl SpHeader {
+    /// 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
+    /// exceed [MAX_APID] or [MAX_SEQ_COUNT] respectively.
     pub fn new(
         ptype: PacketType,
         sec_header: bool,
         apid: u16,
-        ssc: u16,
+        seq_count: u16,
         data_len: u16,
     ) -> Option<Self> {
-        if ssc > 2u16.pow(14) - 1 || apid > MAX_APID {
+        if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
             return None;
         }
         let mut header = SpHeader::default();
         header.packet_id.sec_header_flag = sec_header;
         header.packet_id.apid = apid;
         header.packet_id.ptype = ptype;
-        header.psc.seq_count = ssc;
+        header.psc.seq_count = seq_count;
         header.data_len = data_len;
         Some(header)
     }
 
+    /// Helper function for telemetry space packet headers. The packet type  field will be
+    /// set accordingly.
     pub fn tm(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
         Self::new(PacketType::Tm, false, apid, seq_count, data_len)
     }
 
+    /// Helper function for telecommand space packet headers. The packet type  field will be
+    /// set accordingly.
     pub fn tc(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
         Self::new(PacketType::Tc, false, apid, seq_count, data_len)
     }

src/tc.rs

@@ -26,7 +26,7 @@
 //! println!("{:?}", &test_buf[0..size]);
 //!
 //! // Deserialize from the raw byte representation
-//! let pus_tc_deserialized = PusTc::new_from_raw_slice(&test_buf).expect("Deserialization failed");
+//! let pus_tc_deserialized = PusTc::from_bytes(&test_buf).expect("Deserialization failed");
 //! assert_eq!(pus_tc.service(), 17);
 //! assert_eq!(pus_tc.subservice(), 1);
 //! assert_eq!(pus_tc.apid(), 0x02);
@@ -336,22 +336,21 @@ impl<'slice> PusTc<'slice> {
         let tc_header_len = size_of::<zc::PusTcSecondaryHeader>();
         let total_size = self.len_packed();
         if total_size > slice.len() {
-            return Err(PusError::PacketError(ByteConversionError::ToSliceTooSmall(
-                SizeMissmatch {
+            return Err(ByteConversionError::ToSliceTooSmall(SizeMissmatch {
                 found: slice.len(),
                 expected: total_size,
-                },
-            )));
+            })
+            .into());
         }
         sph_zc
             .to_bytes(&mut slice[curr_idx..curr_idx + CCSDS_HEADER_LEN])
-            .ok_or(PusError::PacketError(ByteConversionError::ZeroCopyToError))?;
+            .ok_or(ByteConversionError::ZeroCopyToError)?;
 
         curr_idx += CCSDS_HEADER_LEN;
         let sec_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
         sec_header
             .write_to_bytes(&mut slice[curr_idx..curr_idx + tc_header_len])
-            .ok_or(PusError::PacketError(ByteConversionError::ZeroCopyToError))?;
+            .ok_or(ByteConversionError::ZeroCopyToError)?;
 
         curr_idx += tc_header_len;
         if let Some(app_data) = self.app_data {
@@ -402,7 +401,7 @@ impl<'slice> PusTc<'slice> {
 
     /// Create a [PusTc] instance from a raw slice. On success, it returns a tuple containing
     /// the instance and the found byte length of the packet
-    pub fn new_from_raw_slice(slice: &'slice [u8]) -> Result<(Self, usize), PusError> {
+    pub fn from_bytes(slice: &'slice [u8]) -> Result<(Self, usize), PusError> {
         let raw_data_len = slice.len();
         if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
             return Err(PusError::RawDataTooShort(raw_data_len));
@@ -410,9 +409,7 @@ impl<'slice> PusTc<'slice> {
         let mut current_idx = 0;
         let sph =
             crate::zc::SpHeader::from_bytes(&slice[current_idx..current_idx + CCSDS_HEADER_LEN])
-                .ok_or(PusError::PacketError(
-                    ByteConversionError::ZeroCopyFromError,
-                ))?;
+                .ok_or(ByteConversionError::ZeroCopyFromError)?;
         current_idx += CCSDS_HEADER_LEN;
         let total_len = sph.total_len();
         if raw_data_len < total_len || total_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
@@ -421,9 +418,7 @@ impl<'slice> PusTc<'slice> {
         let sec_header = zc::PusTcSecondaryHeader::from_bytes(
             &slice[current_idx..current_idx + PUC_TC_SECONDARY_HEADER_LEN],
         )
-        .ok_or(PusError::PacketError(
-            ByteConversionError::ZeroCopyFromError,
-        ))?;
+        .ok_or(ByteConversionError::ZeroCopyFromError)?;
         current_idx += PUC_TC_SECONDARY_HEADER_LEN;
         let raw_data = &slice[0..total_len];
         let pus_tc = PusTc {
@@ -527,8 +522,8 @@ mod tests {
             .write_to_bytes(test_buf.as_mut_slice())
             .expect("Error writing TC to buffer");
         assert_eq!(size, 13);
-        let (tc_from_raw, size) = PusTc::new_from_raw_slice(&test_buf)
-            .expect("Creating PUS TC struct from raw buffer failed");
+        let (tc_from_raw, size) =
+            PusTc::from_bytes(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
         assert_eq!(size, 13);
         verify_test_tc(&tc_from_raw, false, 13);
         assert!(tc_from_raw.user_data().is_none());
@@ -553,8 +548,8 @@ mod tests {
             .write_to_bytes(test_buf.as_mut_slice())
             .expect("Error writing TC to buffer");
         assert_eq!(size, 16);
-        let (tc_from_raw, size) = PusTc::new_from_raw_slice(&test_buf)
-            .expect("Creating PUS TC struct from raw buffer failed");
+        let (tc_from_raw, size) =
+            PusTc::from_bytes(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
         assert_eq!(size, 16);
         verify_test_tc(&tc_from_raw, true, 16);
         let user_data = tc_from_raw.user_data().unwrap();
@@ -584,7 +579,7 @@ mod tests {
             .write_to_bytes(test_buf.as_mut_slice())
             .expect("Error writing TC to buffer");
         test_buf[12] = 0;
-        let res = PusTc::new_from_raw_slice(&test_buf);
+        let res = PusTc::from_bytes(&test_buf);
         assert!(res.is_err());
         let err = res.unwrap_err();
         assert!(matches!(err, PusError::IncorrectCrc { .. }));
@@ -636,7 +631,7 @@ mod tests {
         assert!(res.is_err());
         let err = res.unwrap_err();
         match err {
-            PusError::PacketError(err) => match err {
+            PusError::ByteConversionError(err) => match err {
                 ByteConversionError::ToSliceTooSmall(missmatch) => {
                     assert_eq!(missmatch.expected, pus_tc.len_packed());
                     assert_eq!(missmatch.found, 12);

src/time.rs

@@ -91,9 +91,24 @@ pub trait CcsdsTimeProvider {
     fn p_field(&self) -> (usize, [u8; 2]);
     fn ccdsd_time_code(&self) -> CcsdsTimeCodes;
     fn unix_seconds(&self) -> i64;
-    fn date_time(&self) -> DateTime<Utc>;
+    fn date_time(&self) -> Option<DateTime<Utc>>;
 }
 
+/// This object is the abstraction for the CCSDS Day Segmented Time Code (CDS).
+///
+/// It has the capability to generate and read timestamps as specified in the CCSDS 301.0-B-4
+/// section 3.3
+///
+/// # Example
+///
+/// ```
+/// use spacepackets::time::{CdsShortTimeProvider, TimeWriter};
+/// use spacepackets::time::CcsdsTimeCodes::Cds;
+/// let timestamp_now = CdsShortTimeProvider::from_now().unwrap();
+/// let mut raw_stamp = [0; 7];
+/// timestamp_now.write_to_bytes(&mut raw_stamp).unwrap();
+/// assert_eq!((raw_stamp[0] >> 4) & 0b111, Cds as u8);
+/// ```
 #[derive(Debug, Copy, Clone, Default)]
 pub struct CdsShortTimeProvider {
     pfield: u8,
@@ -106,7 +121,7 @@ pub struct CdsShortTimeProvider {
 impl CdsShortTimeProvider {
     pub fn new(ccsds_days: u16, ms_of_day: u32) -> Self {
         let provider = Self {
-            pfield: (CcsdsTimeCodes::Cds as u8) << 4,
+            pfield: (Cds as u8) << 4,
             ccsds_days,
             ms_of_day,
             unix_seconds: 0,
@@ -192,15 +207,15 @@ impl CcsdsTimeProvider for CdsShortTimeProvider {
     }
 
     fn ccdsd_time_code(&self) -> CcsdsTimeCodes {
-        CcsdsTimeCodes::Cds
+        Cds
     }
 
     fn unix_seconds(&self) -> i64 {
         self.unix_seconds
     }
 
-    fn date_time(&self) -> DateTime<Utc> {
-        self.date_time.expect("Invalid date time")
+    fn date_time(&self) -> Option<DateTime<Utc>> {
+        self.date_time
     }
 }
 
@@ -235,19 +250,9 @@ impl TimeReader for CdsShortTimeProvider {
         match CcsdsTimeCodes::try_from(pfield >> 4 & 0b111) {
             Ok(cds_type) => match cds_type {
                 Cds => (),
-                _ => {
-                    return Err(TimestampError::InvalidTimeCode(
-                        CcsdsTimeCodes::Cds,
-                        cds_type as u8,
-                    ))
-                }
+                _ => return Err(TimestampError::InvalidTimeCode(Cds, cds_type as u8)),
             },
-            _ => {
-                return Err(TimestampError::InvalidTimeCode(
-                    CcsdsTimeCodes::Cds,
-                    pfield >> 4 & 0b111,
-                ))
-            }
+            _ => return Err(TimestampError::InvalidTimeCode(Cds, pfield >> 4 & 0b111)),
         };
         let ccsds_days: u16 = u16::from_be_bytes(buf[1..3].try_into().unwrap());
         let ms_of_day: u32 = u32::from_be_bytes(buf[3..7].try_into().unwrap());
@@ -283,12 +288,9 @@ mod tests {
             time_stamper.unix_seconds(),
             (DAYS_CCSDS_TO_UNIX * SECONDS_PER_DAY as i32) as i64
         );
-        assert_eq!(time_stamper.ccdsd_time_code(), CcsdsTimeCodes::Cds);
-        assert_eq!(
-            time_stamper.p_field(),
-            (1, [(CcsdsTimeCodes::Cds as u8) << 4, 0])
-        );
-        let date_time = time_stamper.date_time();
+        assert_eq!(time_stamper.ccdsd_time_code(), Cds);
+        assert_eq!(time_stamper.p_field(), (1, [(Cds as u8) << 4, 0]));
+        let date_time = time_stamper.date_time().unwrap();
         assert_eq!(date_time.year(), 1958);
         assert_eq!(date_time.month(), 1);
         assert_eq!(date_time.day(), 1);
@@ -301,7 +303,7 @@ mod tests {
     fn test_time_stamp_unix_epoch() {
         let time_stamper = CdsShortTimeProvider::new((-DAYS_CCSDS_TO_UNIX) as u16, 0);
         assert_eq!(time_stamper.unix_seconds(), 0);
-        let date_time = time_stamper.date_time();
+        let date_time = time_stamper.date_time().unwrap();
         assert_eq!(date_time.year(), 1970);
         assert_eq!(date_time.month(), 1);
         assert_eq!(date_time.day(), 1);
@@ -392,7 +394,7 @@ mod tests {
         let err = res.unwrap_err();
         match err {
             InvalidTimeCode(code, raw) => {
-                assert_eq!(code, CcsdsTimeCodes::Cds);
+                assert_eq!(code, Cds);
                 assert_eq!(raw, 0);
             }
             OtherPacketError(_) => {}
@@ -425,7 +427,7 @@ mod tests {
     fn test_time_now() {
         let timestamp_now = CdsShortTimeProvider::from_now().unwrap();
         let compare_stamp = Utc::now();
-        let dt = timestamp_now.date_time();
+        let dt = timestamp_now.date_time().unwrap();
         if compare_stamp.year() > dt.year() {
             assert_eq!(compare_stamp.year() - dt.year(), 1);
         } else {

src/tm.rs

@@ -314,23 +314,22 @@ impl<'slice> PusTm<'slice> {
         let sph_zc = crate::zc::SpHeader::from(self.sp_header);
         let total_size = self.len_packed();
         if total_size > slice.len() {
-            return Err(PusError::PacketError(ByteConversionError::ToSliceTooSmall(
-                SizeMissmatch {
+            return Err(ByteConversionError::ToSliceTooSmall(SizeMissmatch {
                 found: slice.len(),
                 expected: total_size,
-                },
-            )));
+            })
+            .into());
         }
         sph_zc
             .to_bytes(&mut slice[curr_idx..curr_idx + CCSDS_HEADER_LEN])
-            .ok_or(PusError::PacketError(ByteConversionError::ZeroCopyToError))?;
+            .ok_or(ByteConversionError::ZeroCopyToError)?;
 
         curr_idx += CCSDS_HEADER_LEN;
         let sec_header_len = size_of::<zc::PusTmSecHeaderWithoutTimestamp>();
         let sec_header = zc::PusTmSecHeaderWithoutTimestamp::try_from(self.sec_header).unwrap();
         sec_header
             .write_to_bytes(&mut slice[curr_idx..curr_idx + sec_header_len])
-            .ok_or(PusError::PacketError(ByteConversionError::ZeroCopyToError))?;
+            .ok_or(ByteConversionError::ZeroCopyToError)?;
         curr_idx += sec_header_len;
         let timestamp_len = self.sec_header.time_stamp.len();
         slice[curr_idx..curr_idx + timestamp_len].copy_from_slice(self.sec_header.time_stamp);
@@ -388,7 +387,7 @@ impl<'slice> PusTm<'slice> {
     /// Create a [PusTm] instance from a raw slice. On success, it returns a tuple containing
     /// the instance and the found byte length of the packet. The timestamp length needs to be
     /// known beforehand.
-    pub fn new_from_raw_slice(
+    pub fn from_bytes(
         slice: &'slice [u8],
         timestamp_len: usize,
     ) -> Result<(Self, usize), PusError> {
@@ -399,9 +398,7 @@ impl<'slice> PusTm<'slice> {
         let mut current_idx = 0;
         let sph =
             crate::zc::SpHeader::from_bytes(&slice[current_idx..current_idx + CCSDS_HEADER_LEN])
-                .ok_or(PusError::PacketError(
-                    ByteConversionError::ZeroCopyFromError,
-                ))?;
+                .ok_or(ByteConversionError::ZeroCopyFromError)?;
         current_idx += 6;
         let total_len = sph.total_len();
         if raw_data_len < total_len || total_len < PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA {
@@ -410,9 +407,7 @@ impl<'slice> PusTm<'slice> {
         let sec_header_zc = zc::PusTmSecHeaderWithoutTimestamp::from_bytes(
             &slice[current_idx..current_idx + PUC_TM_MIN_SEC_HEADER_LEN],
         )
-        .ok_or(PusError::PacketError(
-            ByteConversionError::ZeroCopyFromError,
-        ))?;
+        .ok_or(ByteConversionError::ZeroCopyFromError)?;
         current_idx += PUC_TM_MIN_SEC_HEADER_LEN;
         let zc_sec_header_wrapper = zc::PusTmSecHeader {
             zc_header: sec_header_zc,
@@ -545,8 +540,7 @@ mod tests {
             .write_to_bytes(&mut buf)
             .expect("Serialization failed");
         assert_eq!(ser_len, 22);
-        let (tm_deserialized, size) =
-            PusTm::new_from_raw_slice(&buf, 7).expect("Deserialization failed");
+        let (tm_deserialized, size) = PusTm::from_bytes(&buf, 7).expect("Deserialization failed");
         assert_eq!(ser_len, size);
         verify_ping_reply(&tm_deserialized, false, 22, dummy_time_stamp());
     }
@@ -580,9 +574,9 @@ mod tests {
         let res = pus_tm.write_to_bytes(&mut buf);
         assert!(res.is_err());
         let error = res.unwrap_err();
-        assert!(matches!(error, PusError::PacketError { .. }));
+        assert!(matches!(error, PusError::ByteConversionError { .. }));
         match error {
-            PusError::PacketError(err) => match err {
+            PusError::ByteConversionError(err) => match err {
                 ByteConversionError::ToSliceTooSmall(size_missmatch) => {
                     assert_eq!(size_missmatch.expected, 22);
                     assert_eq!(size_missmatch.found, 16);