prepare v0.5.3

CHANGELOG.md

@@ -8,6 +8,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.5.3] 2023-02-05
+
+## Added
+
+- `num_enum` dependency to avoid boilerplate code for primtive to enum conversions, for example
+  for the PUS subservices.
+- `ecss.event` module containing a `Subservice` enum.
+- `ecss.verification` module containing a `Subservice` enum.
+- `ecss.scheduling` module containing a `Subservice` enum and some other helper enumerations.
+- `ecss.hk` module containing a `Subservice` enum.
+
+## Changed
+
+- Added missing Service IDs to `ecss.PusServiceId` and marked in `#[non_exhaustive]`.
+
+## Fixed
+
+- `time.UnixTimestamp`: All constructors and `From` conversions now use the `new` constructor,
+  which should cause a correct conversion of 0 subsecond milliseconds to a `None` value.
+
+# [v0.5.2] 2023-01-26
+
 ## Added
 
 - Added `.gitignore`.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spacepackets"
-version = "0.5.2"
+version = "0.5.3"
 edition = "2021"
 rust-version = "1.60"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
@@ -17,6 +17,10 @@ zerocopy = "0.6"
 crc = "3"
 delegate = ">=0.8, <0.10"
 
+[dependencies.num_enum]
+version = "0.5"
+default-features = false
+
 [dependencies.serde]
 version = "1"
 optional = true

src/ecss/event.rs

@@ -0,0 +1,43 @@
+//! PUS Service 5 Events
+use num_enum::{IntoPrimitive, TryFromPrimitive};
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u8)]
+pub enum Subservice {
+    TmInfoReport = 1,
+    TmLowSeverityReport = 2,
+    TmMediumSeverityReport = 3,
+    TmHighSeverityReport = 4,
+    TcEnableEventGeneration = 5,
+    TcDisableEventGeneration = 6,
+    TcReportDisabledList = 7,
+    TmDisabledEventsReport = 8,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_conv_into_u8() {
+        let subservice: u8 = Subservice::TmLowSeverityReport.into();
+        assert_eq!(subservice, 2);
+    }
+
+    #[test]
+    fn test_conv_from_u8() {
+        let subservice: Subservice = 2.try_into().unwrap();
+        assert_eq!(subservice, Subservice::TmLowSeverityReport);
+    }
+
+    #[test]
+    fn test_conv_fails() {
+        let conversion = Subservice::try_from(9);
+        assert!(conversion.is_err());
+        let err = conversion.unwrap_err();
+        assert_eq!(err.number, 9);
+    }
+}

src/ecss/hk.rs

@@ -0,0 +1,31 @@
+//! PUS Service 3 Housekeeping
+use num_enum::{IntoPrimitive, TryFromPrimitive};
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u8)]
+pub enum Subservice {
+    // Regular HK
+    TcCreateHkReportStructure = 1,
+    TcDeleteHkReportStructures = 3,
+    TcEnableHkGeneration = 5,
+    TcDisableHkGeneration = 6,
+    TcReportHkReportStructures = 9,
+    TmHkPacket = 25,
+    TcGenerateOneShotHk = 27,
+    TcModifyHkCollectionInterval = 31,
+
+    // Diagnostics HK
+    TcCreateDiagReportStructure = 2,
+    TcDeleteDiagReportStructures = 4,
+    TcEnableDiagGeneration = 7,
+    TcDisableDiagGeneration = 8,
+    TmHkStructuresReport = 10,
+    TcReportDiagReportStructures = 11,
+    TmDiagStructuresReport = 12,
+    TmDiagPacket = 26,
+    TcGenerateOneShotDiag = 28,
+    TcModifyDiagCollectionInterval = 32,
+}

src/ecss/mod.rs

@@ -7,30 +7,68 @@ use crate::{ByteConversionError, CcsdsPacket, SizeMissmatch};
 use core::fmt::{Debug, Display, Formatter};
 use core::mem::size_of;
 use crc::{Crc, CRC_16_IBM_3740};
+use num_enum::{IntoPrimitive, TryFromPrimitive};
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 #[cfg(feature = "std")]
 use std::error::Error;
 
+pub mod event;
+pub mod hk;
+pub mod scheduling;
+pub mod verification;
+
 pub type CrcType = u16;
 
 /// CRC algorithm used by the PUS standard.
 pub const CRC_CCITT_FALSE: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_3740);
 pub const CCSDS_HEADER_LEN: usize = size_of::<crate::zc::SpHeader>();
 
-#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u8)]
+#[non_exhaustive]
 pub enum PusServiceId {
     /// Service 1
     Verification = 1,
+    /// Service 2
+    DeviceAccess = 2,
     /// Service 3
     Housekeeping = 3,
+    /// Service 4
+    ParameterStatistics = 4,
     /// Service 5
     Event = 5,
+    /// Service 6
+    MemoryManagement = 6,
     /// Service 8
     Action = 8,
+    /// Service 9
+    TimeManagement = 9,
+    /// Service 11
+    Scheduling = 11,
+    /// Service 12
+    OnBoardMonitoring = 12,
+    /// Service 13
+    LargePacketTransfer = 13,
+    /// Service 14
+    RealTimeForwardingControl = 14,
+    /// Service 15
+    StorageAndRetrival = 15,
     /// Service 17
     Test = 17,
+    /// Service 18
+    OpsAndProcedures = 18,
+    /// Service 19
+    EventAction = 19,
+    /// Service 20
+    Parameter = 20,
+    /// Service 21
+    RequestSequencing = 21,
+    /// Service 22
+    PositionBasedScheduling = 22,
+    /// Service 23
+    FileManagement = 23,
 }
 
 /// All PUS versions. Only PUS C is supported by this library.

src/ecss/scheduling.rs

@@ -0,0 +1,105 @@
+//! PUS Service 11 Scheduling
+use num_enum::{IntoPrimitive, TryFromPrimitive};
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, PartialEq, Eq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u8)]
+pub enum Subservice {
+    // Core subservices
+    TcEnableScheduling = 1,
+    TcDisableScheduling = 2,
+    TcResetScheduling = 3,
+    TcInsertActivity = 4,
+    TcDeleteActivityByRequestId = 5,
+    TcDeleteActivitiesByFilter = 6,
+
+    // Time shift subservices
+    TcTimeShiftActivityWithRequestId = 7,
+    TcTimeShiftActivitiesByFilter = 8,
+    TcTimeShiftAll = 15,
+
+    // Reporting subservices
+    TcDetailReportByRequestId = 9,
+    TmDetailReport = 10,
+    TcDetailReportByFilter = 11,
+    TcSummaryReportByRequestId = 12,
+    TmSummaryReport = 13,
+    TcSummaryReportByFilter = 14,
+    TcDetailReportAll = 16,
+    TcSummaryReportAll = 17,
+
+    // Subschedule subservices
+    TcReportSubscheduleStatus = 18,
+    TmReportSubscheduleStatus = 19,
+    TcEnableSubschedule = 20,
+    TcDisableSubschedule = 21,
+
+    // Group subservices
+    TcCreateScheduleGroup = 22,
+    TcDeleteScheduleGroup = 23,
+    TcEnableScheduleGroup = 24,
+    TcDisableScheduleGroup = 25,
+    TcReportAllGroupsStatus = 26,
+    TmReportAllGroupsStatus = 27,
+}
+
+/// This status applies to sub-schedules and groups as well as specified in ECSS-E-ST-70-41C 8.11.3
+#[derive(Debug, PartialEq, Eq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+pub enum SchedStatus {
+    Disabled = 0,
+    Enabled = 1,
+}
+
+impl From<bool> for SchedStatus {
+    fn from(value: bool) -> Self {
+        if value {
+            SchedStatus::Enabled
+        } else {
+            SchedStatus::Disabled
+        }
+    }
+}
+
+/// Time window types as specified in  ECSS-E-ST-70-41C 8.11.3
+#[derive(Debug, PartialEq, Eq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+pub enum TimeWindowType {
+    SelectAll = 0,
+    TimeTagToTimeTag = 1,
+    FromTimeTag = 2,
+    ToTimeTag = 3,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_bool_conv_0() {
+        let enabled = true;
+        let status: SchedStatus = enabled.into();
+        assert_eq!(status, SchedStatus::Enabled)
+    }
+
+    #[test]
+    fn test_bool_conv_1() {
+        let enabled = false;
+        let status: SchedStatus = enabled.into();
+        assert_eq!(status, SchedStatus::Disabled)
+    }
+
+    #[test]
+    fn test_conv_into_u8() {
+        let subservice: u8 = Subservice::TcCreateScheduleGroup.into();
+        assert_eq!(subservice, 22);
+    }
+
+    #[test]
+    fn test_conv_from_u8() {
+        let subservice: Subservice = 22u8.try_into().unwrap();
+        assert_eq!(subservice, Subservice::TcCreateScheduleGroup);
+    }
+}

src/ecss/verification.rs

@@ -0,0 +1,35 @@
+//! PUS Service 1 Verification
+use num_enum::{IntoPrimitive, TryFromPrimitive};
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u8)]
+pub enum Subservice {
+    TmAcceptanceSuccess = 1,
+    TmAcceptanceFailure = 2,
+    TmStartSuccess = 3,
+    TmStartFailure = 4,
+    TmStepSuccess = 5,
+    TmStepFailure = 6,
+    TmCompletionSuccess = 7,
+    TmCompletionFailure = 8,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_conv_into_u8() {
+        let subservice: u8 = Subservice::TmCompletionSuccess.into();
+        assert_eq!(subservice, 7);
+    }
+
+    #[test]
+    fn test_conv_from_u8() {
+        let subservice: Subservice = 7.try_into().unwrap();
+        assert_eq!(subservice, Subservice::TmCompletionSuccess);
+    }
+}

src/time/cds.rs

@@ -577,15 +577,14 @@ impl<ProvidesDaysLen: ProvidesDaysLength> TimeProvider<ProvidesDaysLen> {
     }
 
     #[inline]
-    fn calc_unix_seconds(&mut self, unix_days_seconds: i64, ms_of_day: u32) {
-        self.unix_stamp.unix_seconds = unix_days_seconds;
-        self.unix_stamp.subsecond_millis = Some((ms_of_day % 1000) as u16);
+    fn calc_unix_seconds(&mut self, mut unix_days_seconds: i64, ms_of_day: u32) {
         let seconds_of_day = (ms_of_day / 1000) as i64;
-        if self.unix_stamp.unix_seconds < 0 {
-            self.unix_stamp.unix_seconds -= seconds_of_day;
+        if unix_days_seconds < 0 {
+            unix_days_seconds -= seconds_of_day;
         } else {
-            self.unix_stamp.unix_seconds += seconds_of_day;
+            unix_days_seconds += seconds_of_day;
         }
+        self.unix_stamp = UnixTimestamp::const_new(unix_days_seconds, (ms_of_day % 1000) as u16);
     }
 
     fn calc_date_time(&self, ns_since_last_second: u32) -> Option<DateTime<Utc>> {
@@ -1319,12 +1318,9 @@ mod tests {
             (DAYS_CCSDS_TO_UNIX * SECONDS_PER_DAY as i32) as i64
         );
         let subsecond_millis = unix_stamp.subsecond_millis;
-        assert!(subsecond_millis.is_some());
-
-        assert_eq!(subsecond_millis.unwrap(), 0);
+        assert!(subsecond_millis.is_none());
         assert_eq!(time_stamper.submillis_precision(), None);
-        assert!(time_stamper.subsecond_millis().is_some());
-        assert_eq!(time_stamper.subsecond_millis().unwrap(), 0);
+        assert!(time_stamper.subsecond_millis().is_none());
         assert_eq!(time_stamper.ccdsd_time_code(), CcsdsTimeCodes::Cds);
         assert_eq!(
             time_stamper.p_field(),

src/time/mod.rs

@@ -223,10 +223,10 @@ pub trait CcsdsTimeProvider {
     fn unix_seconds(&self) -> i64;
     fn subsecond_millis(&self) -> Option<u16>;
     fn unix_stamp(&self) -> UnixTimestamp {
-        UnixTimestamp {
-            unix_seconds: self.unix_seconds(),
-            subsecond_millis: self.subsecond_millis(),
+        if self.subsecond_millis().is_none() {
+            return UnixTimestamp::new_only_seconds(self.unix_seconds());
         }
+        UnixTimestamp::const_new(self.unix_seconds(), self.subsecond_millis().unwrap())
     }
 
     fn date_time(&self) -> Option<DateTime<Utc>>;
@@ -285,10 +285,7 @@ impl UnixTimestamp {
     pub fn from_now() -> Result<Self, SystemTimeError> {
         let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;
         let epoch = now.as_secs();
-        Ok(UnixTimestamp {
-            unix_seconds: epoch as i64,
-            subsecond_millis: Some(now.subsec_millis() as u16),
-        })
+        Ok(Self::const_new(epoch as i64, now.subsec_millis() as u16))
     }
 
     #[inline]
@@ -310,10 +307,7 @@ impl UnixTimestamp {
 
 impl From<DateTime<Utc>> for UnixTimestamp {
     fn from(value: DateTime<Utc>) -> Self {
-        Self {
-            unix_seconds: value.timestamp(),
-            subsecond_millis: Some(value.timestamp_subsec_millis() as u16),
-        }
+        Self::const_new(value.timestamp(), value.timestamp_subsec_millis() as u16)
     }
 }