Integration of the mini simulator into the sat-rs example

Reviewed-on: #196

Cargo.toml

@@ -11,6 +11,5 @@ members = [
 exclude = [
     "embedded-examples/stm32f3-disco-rtic",
     "embedded-examples/stm32h7-rtic",
-    "serialization-prototyping",
 ]
 

README.md

@@ -69,6 +69,7 @@ Currently this library has the following flight heritage:
   [flown on the satellite](https://blogs.esa.int/rocketscience/2024/05/21/ops-sat-reentry-tomorrow-final-experiments-continue/).
   The application is strongly based on the sat-rs example application. You can find the repository
   of the experiment [here](https://egit.irs.uni-stuttgart.de/rust/ops-sat-rs).
+- Development and use of a sat-rs-based [Demonstration Onboard Software](https://egit.irs.uni-stuttgart.de/rust/eurosim-obsw) alongside a Flight System Simulator in the context of a [Bachelors Thesis](https://www.researchgate.net/publication/380785984_Design_and_Development_of_a_Hardware-in-the-Loop_EuroSim_Demonstrator) at [Airbus Netherlands](https://www.airbusdefenceandspacenetherlands.nl/).
 
 # Coverage
 

satrs-example/src/acs/mgm.rs

@@ -19,7 +19,7 @@ use satrs::mode::{
 };
 use satrs::pus::{EcssTmSender, PusTmVariant};
 use satrs::request::{GenericMessage, MessageMetadata, UniqueApidTargetId};
-use satrs_example::config::components::PUS_MODE_SERVICE;
+use satrs_example::config::components::{NO_SENDER, PUS_MODE_SERVICE};
 
 use crate::hk::PusHkHelper;
 use crate::pus::hk::{HkReply, HkReplyVariant};
@@ -421,9 +421,12 @@ impl<
         self.mode_helpers.target = None;
         self.announce_mode(requestor, false);
         if let Some(requestor) = requestor {
+            if requestor.sender_id() == NO_SENDER {
+                return Ok(());
+            }
             if requestor.sender_id() != PUS_MODE_SERVICE.id() {
                 log::warn!(
-                    "can not send back mode reply to sender {}",
+                    "can not send back mode reply to sender {:x}",
                     requestor.sender_id()
                 );
             } else {
@@ -532,7 +535,7 @@ mod tests {
                 hk_reply_rx,
                 handler: MgmHandlerLis3Mdl::new(
                     UniqueApidTargetId::new(Apid::Acs as u16, 1),
-                    "test-mgm",
+                    "TEST_MGM",
                     mode_interface,
                     composite_request_rx,
                     hk_reply_tx,

satrs-example/src/config.rs

@@ -122,7 +122,7 @@ pub mod mode_err {
 }
 
 pub mod components {
-    use satrs::request::UniqueApidTargetId;
+    use satrs::{request::UniqueApidTargetId, ComponentId};
     use strum::EnumIter;
 
     #[derive(Copy, Clone, PartialEq, Eq, EnumIter)]
@@ -184,6 +184,7 @@ pub mod components {
         UniqueApidTargetId::new(Apid::Tmtc as u16, TmtcId::UdpServer as u32);
     pub const TCP_SERVER: UniqueApidTargetId =
         UniqueApidTargetId::new(Apid::Tmtc as u16, TmtcId::TcpServer as u32);
+    pub const NO_SENDER: ComponentId = ComponentId::MAX;
 }
 
 pub mod pool {

satrs-example/src/eps/pcdu.rs

@@ -15,7 +15,10 @@ use satrs::{
     request::{GenericMessage, MessageMetadata, UniqueApidTargetId},
     spacepackets::ByteConversionError,
 };
-use satrs_example::{config::components::PUS_MODE_SERVICE, DeviceMode, TimestampHelper};
+use satrs_example::{
+    config::components::{NO_SENDER, PUS_MODE_SERVICE},
+    DeviceMode, TimestampHelper,
+};
 use satrs_minisim::{
     eps::{
         PcduReply, PcduRequest, PcduSwitch, SwitchMap, SwitchMapBinaryWrapper, SwitchMapWrapper,
@@ -60,9 +63,9 @@ impl SerialInterface for SerialInterfaceToSim {
     type Error = ();
 
     fn send(&self, data: &[u8]) -> Result<(), Self::Error> {
-        let request: SimRequest = serde_json::from_slice(data).unwrap();
+        let request: PcduRequest = serde_json::from_slice(data).expect("expected a PCDU request");
         self.sim_request_tx
-            .send(request)
+            .send(SimRequest::new_with_epoch_time(request))
             .expect("failed to send request to simulation");
         Ok(())
     }
@@ -101,9 +104,7 @@ impl SerialInterface for SerialInterfaceDummy {
     type Error = ();
 
     fn send(&self, data: &[u8]) -> Result<(), Self::Error> {
-        let sim_req: SimRequest = serde_json::from_slice(data).unwrap();
-        let pcdu_req =
-            PcduRequest::from_sim_message(&sim_req).expect("PCDU request creation failed");
+        let pcdu_req: PcduRequest = serde_json::from_slice(data).unwrap();
         let switch_map_mut = &mut self.switch_map.borrow_mut().0;
         match pcdu_req {
             PcduRequest::SwitchDevice { switch, state } => {
@@ -119,7 +120,7 @@ impl SerialInterface for SerialInterfaceDummy {
             PcduRequest::RequestSwitchInfo => {
                 let mut reply_deque_mut = self.reply_deque.borrow_mut();
                 reply_deque_mut.push_back(SimReply::new(&PcduReply::SwitchInfo(
-                    self.switch_map.borrow().0.clone(),
+                    switch_map_mut.clone(),
                 )));
             }
         };
@@ -130,15 +131,13 @@ impl SerialInterface for SerialInterfaceDummy {
         &self,
         mut f: ReplyHandler,
     ) -> Result<(), Self::Error> {
-        if self.reply_deque.borrow().is_empty() {
+        if self.reply_queue_empty() {
             return Ok(());
         }
         loop {
-            let mut reply_deque_mut = self.reply_deque.borrow_mut();
-            let next_reply = reply_deque_mut.pop_front().unwrap();
-            let reply = serde_json::to_string(&next_reply).unwrap();
+            let reply = self.get_next_reply_as_string();
             f(reply.as_bytes());
-            if reply_deque_mut.is_empty() {
+            if self.reply_queue_empty() {
                 break;
             }
         }
@@ -146,6 +145,18 @@ impl SerialInterface for SerialInterfaceDummy {
     }
 }
 
+impl SerialInterfaceDummy {
+    fn get_next_reply_as_string(&self) -> String {
+        let mut reply_deque_mut = self.reply_deque.borrow_mut();
+        let next_reply = reply_deque_mut.pop_front().unwrap();
+        serde_json::to_string(&next_reply).unwrap()
+    }
+
+    fn reply_queue_empty(&self) -> bool {
+        self.reply_deque.borrow().is_empty()
+    }
+}
+
 pub enum SerialSimInterfaceWrapper {
     Dummy(SerialInterfaceDummy),
     Sim(SerialInterfaceToSim),
@@ -371,10 +382,12 @@ impl<ComInterface: SerialInterface, TmSender: EcssTmSender> PcduHandler<ComInter
                 PcduReply::SwitchInfo(switch_info) => {
                     let switch_map_wrapper =
                         SwitchMapWrapper::from_binary_switch_map_ref(&switch_info);
-                    self.shared_switch_map
+                    let mut shared_switch_map = self
+                        .shared_switch_map
                         .lock()
-                        .expect("failed to lock switch map")
-                        .switch_map = switch_map_wrapper.0;
+                        .expect("failed to lock switch map");
+                    shared_switch_map.switch_map = switch_map_wrapper.0;
+                    shared_switch_map.valid = true;
                 }
             }
         }) {
@@ -427,6 +440,9 @@ impl<ComInterface: SerialInterface, TmSender: EcssTmSender> ModeRequestHandler
     ) -> Result<(), Self::Error> {
         self.announce_mode(requestor, false);
         if let Some(requestor) = requestor {
+            if requestor.sender_id() == NO_SENDER {
+                return Ok(());
+            }
             if requestor.sender_id() != PUS_MODE_SERVICE.id() {
                 log::warn!(
                     "can not send back mode reply to sender {}",
@@ -465,3 +481,242 @@ impl<ComInterface: SerialInterface, TmSender: EcssTmSender> ModeRequestHandler
         Ok(())
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::sync::mpsc;
+
+    use satrs::{
+        mode::ModeRequest, power::SwitchStateBinary, request::GenericMessage, tmtc::PacketAsVec,
+    };
+    use satrs_example::config::components::{Apid, MGM_HANDLER_0};
+    use satrs_minisim::eps::SwitchMapBinary;
+
+    use super::*;
+
+    #[derive(Default)]
+    pub struct SerialInterfaceTest {
+        pub inner: SerialInterfaceDummy,
+        pub send_queue: RefCell<VecDeque<Vec<u8>>>,
+        pub reply_queue: RefCell<VecDeque<String>>,
+    }
+
+    impl SerialInterface for SerialInterfaceTest {
+        type Error = ();
+
+        fn send(&self, data: &[u8]) -> Result<(), Self::Error> {
+            let mut send_queue_mut = self.send_queue.borrow_mut();
+            send_queue_mut.push_back(data.to_vec());
+            self.inner.send(data)
+        }
+
+        fn try_recv_replies<ReplyHandler: FnMut(&[u8])>(
+            &self,
+            mut f: ReplyHandler,
+        ) -> Result<(), Self::Error> {
+            if self.inner.reply_queue_empty() {
+                return Ok(());
+            }
+            loop {
+                let reply = self.inner.get_next_reply_as_string();
+                self.reply_queue.borrow_mut().push_back(reply.clone());
+                f(reply.as_bytes());
+                if self.inner.reply_queue_empty() {
+                    break;
+                }
+            }
+            Ok(())
+        }
+    }
+
+    pub struct PcduTestbench {
+        pub mode_request_tx: mpsc::Sender<GenericMessage<ModeRequest>>,
+        pub mode_reply_rx_to_pus: mpsc::Receiver<GenericMessage<ModeReply>>,
+        pub mode_reply_rx_to_parent: mpsc::Receiver<GenericMessage<ModeReply>>,
+        pub composite_request_tx: mpsc::Sender<GenericMessage<CompositeRequest>>,
+        pub hk_reply_rx: mpsc::Receiver<GenericMessage<HkReply>>,
+        pub tm_rx: mpsc::Receiver<PacketAsVec>,
+        pub switch_request_tx: mpsc::Sender<GenericMessage<SwitchRequest>>,
+        pub handler: PcduHandler<SerialInterfaceTest, mpsc::Sender<PacketAsVec>>,
+    }
+
+    impl PcduTestbench {
+        pub fn new() -> Self {
+            let (mode_request_tx, mode_request_rx) = mpsc::channel();
+            let (mode_reply_tx_to_pus, mode_reply_rx_to_pus) = mpsc::channel();
+            let (mode_reply_tx_to_parent, mode_reply_rx_to_parent) = mpsc::sync_channel(5);
+            let mode_interface = MpscModeLeafInterface {
+                request_rx: mode_request_rx,
+                reply_to_pus_tx: mode_reply_tx_to_pus,
+                reply_to_parent_tx: mode_reply_tx_to_parent,
+            };
+            let (composite_request_tx, composite_request_rx) = mpsc::channel();
+            let (hk_reply_tx, hk_reply_rx) = mpsc::channel();
+            let (tm_tx, tm_rx) = mpsc::channel::<PacketAsVec>();
+            let (switch_request_tx, switch_reqest_rx) = mpsc::channel();
+            let shared_switch_map = Arc::new(Mutex::new(SwitchSet::default()));
+            Self {
+                mode_request_tx,
+                mode_reply_rx_to_pus,
+                mode_reply_rx_to_parent,
+                composite_request_tx,
+                hk_reply_rx,
+                tm_rx,
+                switch_request_tx,
+                handler: PcduHandler::new(
+                    UniqueApidTargetId::new(Apid::Eps as u16, 0),
+                    "TEST_PCDU",
+                    mode_interface,
+                    composite_request_rx,
+                    hk_reply_tx,
+                    switch_reqest_rx,
+                    tm_tx,
+                    SerialInterfaceTest::default(),
+                    shared_switch_map,
+                ),
+            }
+        }
+
+        pub fn verify_switch_info_req_was_sent(&self, expected_queue_len: usize) {
+            // Check that there is now communication happening.
+            let mut send_queue_mut = self.handler.com_interface.send_queue.borrow_mut();
+            assert_eq!(send_queue_mut.len(), expected_queue_len);
+            let packet_sent = send_queue_mut.pop_front().unwrap();
+            drop(send_queue_mut);
+            let pcdu_req: PcduRequest = serde_json::from_slice(&packet_sent).unwrap();
+            assert_eq!(pcdu_req, PcduRequest::RequestSwitchInfo);
+        }
+
+        pub fn verify_switch_req_was_sent(
+            &self,
+            expected_queue_len: usize,
+            switch_id: PcduSwitch,
+            target_state: SwitchStateBinary,
+        ) {
+            // Check that there is now communication happening.
+            let mut send_queue_mut = self.handler.com_interface.send_queue.borrow_mut();
+            assert_eq!(send_queue_mut.len(), expected_queue_len);
+            let packet_sent = send_queue_mut.pop_front().unwrap();
+            drop(send_queue_mut);
+            let pcdu_req: PcduRequest = serde_json::from_slice(&packet_sent).unwrap();
+            assert_eq!(
+                pcdu_req,
+                PcduRequest::SwitchDevice {
+                    switch: switch_id,
+                    state: target_state
+                }
+            )
+        }
+
+        pub fn verify_switch_reply_received(
+            &self,
+            expected_queue_len: usize,
+            expected_map: SwitchMapBinary,
+        ) {
+            // Check that a switch reply was read back.
+            let mut reply_received_mut = self.handler.com_interface.reply_queue.borrow_mut();
+            assert_eq!(reply_received_mut.len(), expected_queue_len);
+            let reply_received = reply_received_mut.pop_front().unwrap();
+            let sim_reply: SimReply = serde_json::from_str(&reply_received).unwrap();
+            let pcdu_reply = PcduReply::from_sim_message(&sim_reply).unwrap();
+            assert_eq!(pcdu_reply, PcduReply::SwitchInfo(expected_map));
+        }
+    }
+
+    #[test]
+    fn test_basic_handler() {
+        let mut testbench = PcduTestbench::new();
+        assert_eq!(testbench.handler.com_interface.send_queue.borrow().len(), 0);
+        assert_eq!(
+            testbench.handler.com_interface.reply_queue.borrow().len(),
+            0
+        );
+        assert_eq!(
+            testbench.handler.mode_and_submode().mode(),
+            DeviceMode::Off as u32
+        );
+        assert_eq!(testbench.handler.mode_and_submode().submode(), 0_u16);
+        testbench.handler.periodic_operation(OpCode::RegularOp);
+        testbench
+            .handler
+            .periodic_operation(OpCode::PollAndRecvReplies);
+        // Handler is OFF, no changes expected.
+        assert_eq!(testbench.handler.com_interface.send_queue.borrow().len(), 0);
+        assert_eq!(
+            testbench.handler.com_interface.reply_queue.borrow().len(),
+            0
+        );
+        assert_eq!(
+            testbench.handler.mode_and_submode().mode(),
+            DeviceMode::Off as u32
+        );
+        assert_eq!(testbench.handler.mode_and_submode().submode(), 0_u16);
+    }
+
+    #[test]
+    fn test_normal_mode() {
+        let mut testbench = PcduTestbench::new();
+        testbench
+            .mode_request_tx
+            .send(GenericMessage::new(
+                MessageMetadata::new(0, PUS_MODE_SERVICE.id()),
+                ModeRequest::SetMode(ModeAndSubmode::new(DeviceMode::Normal as u32, 0)),
+            ))
+            .expect("failed to send mode request");
+        let switch_map_shared = testbench.handler.shared_switch_map.lock().unwrap();
+        assert!(!switch_map_shared.valid);
+        drop(switch_map_shared);
+        testbench.handler.periodic_operation(OpCode::RegularOp);
+        testbench
+            .handler
+            .periodic_operation(OpCode::PollAndRecvReplies);
+        // Check correctness of mode.
+        assert_eq!(
+            testbench.handler.mode_and_submode().mode(),
+            DeviceMode::Normal as u32
+        );
+        assert_eq!(testbench.handler.mode_and_submode().submode(), 0);
+
+        testbench.verify_switch_info_req_was_sent(1);
+        testbench.verify_switch_reply_received(1, SwitchMapBinaryWrapper::default().0);
+
+        let switch_map_shared = testbench.handler.shared_switch_map.lock().unwrap();
+        assert!(switch_map_shared.valid);
+        drop(switch_map_shared);
+    }
+
+    #[test]
+    fn test_switch_request_handling() {
+        let mut testbench = PcduTestbench::new();
+        testbench
+            .mode_request_tx
+            .send(GenericMessage::new(
+                MessageMetadata::new(0, PUS_MODE_SERVICE.id()),
+                ModeRequest::SetMode(ModeAndSubmode::new(DeviceMode::Normal as u32, 0)),
+            ))
+            .expect("failed to send mode request");
+        testbench
+            .switch_request_tx
+            .send(GenericMessage::new(
+                MessageMetadata::new(0, MGM_HANDLER_0.id()),
+                SwitchRequest::new(0, SwitchStateBinary::On),
+            ))
+            .expect("failed to send switch request");
+        testbench.handler.periodic_operation(OpCode::RegularOp);
+        testbench
+            .handler
+            .periodic_operation(OpCode::PollAndRecvReplies);
+
+        testbench.verify_switch_req_was_sent(2, PcduSwitch::Mgm, SwitchStateBinary::On);
+        testbench.verify_switch_info_req_was_sent(1);
+        let mut switch_map = SwitchMapBinaryWrapper::default().0;
+        *switch_map
+            .get_mut(&PcduSwitch::Mgm)
+            .expect("switch state setting failed") = SwitchStateBinary::On;
+        testbench.verify_switch_reply_received(1, switch_map);
+
+        let switch_map_shared = testbench.handler.shared_switch_map.lock().unwrap();
+        assert!(switch_map_shared.valid);
+        drop(switch_map_shared);
+    }
+}

satrs-example/src/main.rs

@@ -22,13 +22,14 @@ use pus::test::create_test_service_dynamic;
 use satrs::hal::std::tcp_server::ServerConfig;
 use satrs::hal::std::udp_server::UdpTcServer;
 use satrs::pus::HandlingStatus;
-use satrs::request::GenericMessage;
+use satrs::request::{GenericMessage, MessageMetadata};
 use satrs::tmtc::{PacketSenderWithSharedPool, SharedPacketPool};
 use satrs_example::config::pool::{create_sched_tc_pool, create_static_pools};
 use satrs_example::config::tasks::{
     FREQ_MS_AOCS, FREQ_MS_PUS_STACK, FREQ_MS_UDP_TMTC, SIM_CLIENT_IDLE_DELAY_MS,
 };
 use satrs_example::config::{OBSW_SERVER_ADDR, PACKET_ID_VALIDATOR, SERVER_PORT};
+use satrs_example::DeviceMode;
 
 use crate::acs::mgm::{
     MgmHandlerLis3Mdl, MpscModeLeafInterface, SpiDummyInterface, SpiSimInterface,
@@ -46,10 +47,12 @@ use crate::pus::scheduler::{create_scheduler_service_dynamic, create_scheduler_s
 use crate::pus::test::create_test_service_static;
 use crate::pus::{PusTcDistributor, PusTcMpscRouter};
 use crate::requests::{CompositeRequest, GenericRequestRouter};
-use satrs::mode::ModeRequest;
+use satrs::mode::{Mode, ModeAndSubmode, ModeRequest};
 use satrs::pus::event_man::EventRequestWithToken;
 use satrs::spacepackets::{time::cds::CdsTime, time::TimeWriter};
-use satrs_example::config::components::{MGM_HANDLER_0, PCDU_HANDLER, TCP_SERVER, UDP_SERVER};
+use satrs_example::config::components::{
+    MGM_HANDLER_0, NO_SENDER, PCDU_HANDLER, TCP_SERVER, UDP_SERVER,
+};
 use std::net::{IpAddr, SocketAddr};
 use std::sync::{mpsc, Mutex};
 use std::sync::{Arc, RwLock};
@@ -98,7 +101,7 @@ fn static_tmtc_pool_main() {
         .insert(PCDU_HANDLER.id(), pcdu_handler_composite_tx);
     request_map
         .mode_router_map
-        .insert(PCDU_HANDLER.id(), pcdu_handler_mode_tx);
+        .insert(PCDU_HANDLER.id(), pcdu_handler_mode_tx.clone());
 
     // This helper structure is used by all telecommand providers which need to send telecommands
     // to the TC source.
@@ -272,6 +275,7 @@ fn static_tmtc_pool_main() {
     } else {
         SerialSimInterfaceWrapper::Dummy(SerialInterfaceDummy::default())
     };
+
     let mut pcdu_handler = PcduHandler::new(
         PCDU_HANDLER,
         "PCDU",
@@ -283,6 +287,13 @@ fn static_tmtc_pool_main() {
         pcdu_serial_interface,
         shared_switch_set,
     );
+    // The PCDU is a critical component which should be in normal mode immediately.
+    pcdu_handler_mode_tx
+        .send(GenericMessage::new(
+            MessageMetadata::new(0, NO_SENDER),
+            ModeRequest::SetMode(ModeAndSubmode::new(DeviceMode::Normal as Mode, 0)),
+        ))
+        .expect("sending initial mode request failed");
 
     info!("Starting TMTC and UDP task");
     let jh_udp_tmtc = thread::Builder::new()
@@ -420,7 +431,7 @@ fn dyn_tmtc_pool_main() {
         .insert(PCDU_HANDLER.id(), pcdu_handler_composite_tx);
     request_map
         .mode_router_map
-        .insert(PCDU_HANDLER.id(), pcdu_handler_mode_tx);
+        .insert(PCDU_HANDLER.id(), pcdu_handler_mode_tx.clone());
 
     // Create event handling components
     // These sender handles are used to send event requests, for example to enable or disable
@@ -583,6 +594,13 @@ fn dyn_tmtc_pool_main() {
         pcdu_serial_interface,
         shared_switch_set,
     );
+    // The PCDU is a critical component which should be in normal mode immediately.
+    pcdu_handler_mode_tx
+        .send(GenericMessage::new(
+            MessageMetadata::new(0, NO_SENDER),
+            ModeRequest::SetMode(ModeAndSubmode::new(DeviceMode::Normal as Mode, 0)),
+        ))
+        .expect("sending initial mode request failed");
 
     info!("Starting TMTC and UDP task");
     let jh_udp_tmtc = thread::Builder::new()

satrs-example/src/pus/hk.rs

@@ -33,6 +33,7 @@ pub struct HkReply {
 }
 
 #[derive(Clone, PartialEq, Debug)]
+#[allow(dead_code)]
 pub enum HkReplyVariant {
     Ack,
     Failed(ResultU16),

satrs-minisim/Cargo.toml

@@ -16,9 +16,9 @@ num_enum = "0.7"
 humantime = "2"
 
 [dependencies.asynchronix]
-version = "0.2.1"
-git = "https://github.com/asynchronics/asynchronix.git"
-branch = "main"
+version = "0.2.2"
+# git = "https://github.com/asynchronics/asynchronix.git"
+# branch = "main"
 features = ["serde"]
 
 [dependencies.satrs]

satrs-minisim/src/controller.rs

@@ -16,10 +16,12 @@ use crate::{
     eps::PcduModel,
 };
 
-const SIM_CTRL_REQ_WIRETAPPING: bool = true;
-const MGM_REQ_WIRETAPPING: bool = true;
-const PCDU_REQ_WIRETAPPING: bool = true;
-const MGT_REQ_WIRETAPPING: bool = true;
+const WARNING_FOR_STALE_DATA: bool = false;
+
+const SIM_CTRL_REQ_WIRETAPPING: bool = false;
+const MGM_REQ_WIRETAPPING: bool = false;
+const PCDU_REQ_WIRETAPPING: bool = false;
+const MGT_REQ_WIRETAPPING: bool = false;
 
 // The simulation controller processes requests and drives the simulation.
 pub struct SimController {
@@ -72,7 +74,7 @@ impl SimController {
         loop {
             match self.request_receiver.try_recv() {
                 Ok(request) => {
-                    if request.timestamp < old_timestamp {
+                    if request.timestamp < old_timestamp && WARNING_FOR_STALE_DATA {
                         log::warn!("stale data with timestamp {:?} received", request.timestamp);
                     }
                     if let Err(e) = match request.component() {

satrs-minisim/src/lib.rs

@@ -236,7 +236,7 @@ pub mod eps {
         RequestSwitchInfo = 1,
     }
 
-    #[derive(Debug, Copy, Clone, Serialize, Deserialize)]
+    #[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
     pub enum PcduRequest {
         SwitchDevice {
             switch: PcduSwitch,

serialization-prototyping/.gitignore

@@ -1 +0,0 @@
-/target

serialization-prototyping/Cargo.toml

@@ -1,14 +0,0 @@
-[package]
-name = "msg-pack-test"
-version = "0.1.0"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-satrs-minisim = { version = "0.1", path = "../satrs-minisim" }
-satrs = { version = "0.2", path = "../satrs" }
-rmp-serde = "1"
-rmpv = { version = "1", features = ["with-serde"] }
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1"

serialization-prototyping/python-test/.gitignore

@@ -1 +0,0 @@
-/venv

serialization-prototyping/python-test/main.py

@@ -1,51 +0,0 @@
-#!/usr/bin/env python3
-import enum
-from socket import AF_INET, SOCK_DGRAM, socket
-from pydantic import BaseModel
-import msgpack
-
-
-TEST_PERSON = {
-    "age": 24,
-    "name": "Nadine",
-}
-
-
-class Devices(str, enum.Enum):
-    MGT = "Mgt"
-    MGM = "Mgm"
-
-
-class SwitchState(str, enum.Enum):
-    OFF = "Off"
-    ON = "On"
-    UNKNOWN = "Unknown"
-    FAULTY = "Faulty"
-
-
-class SwitchMap(BaseModel):
-    valid: bool
-    switch_map: dict[Devices, SwitchState]
-
-
-def msg_pack_unloading(recv_back: bytes):
-    unpacked = msgpack.unpackb(recv_back)
-    print(f"unpacked: {unpacked}")
-    loaded_back = msgpack.loads(recv_back)
-    print(loaded_back)
-
-
-def main():
-    server_socket = socket(AF_INET, SOCK_DGRAM)
-    target_address = "localhost", 7301
-    msg_pack_stuff = msgpack.packb(TEST_PERSON)
-    assert msg_pack_stuff is not None
-    _ = server_socket.sendto(msg_pack_stuff, target_address)
-    recv_back = server_socket.recv(4096)
-    print(f"recv back: {recv_back}")
-    switch_map = SwitchMap.model_validate_json(recv_back)
-    print(f"switch map: {switch_map}")
-
-
-if __name__ == "__main__":
-    main()

serialization-prototyping/python-test/requirements.txt

@@ -1,2 +0,0 @@
-msgpack==1.0.8
-pydantic==2.7

serialization-prototyping/src/archive.rs

@@ -1,88 +0,0 @@
-#[derive(Debug, Clone, Copy, PartialEq, Deserialize, Serialize)]
-pub enum Color {
-    Red = 0,
-    Green = 1,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
-struct Human {
-    age: u16,
-    name: String,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
-struct HumanAdvanced {
-    id: u32,
-    age: u16,
-    name: String,
-    fav_color: Color,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
-struct HumanGroup {
-    humans: Vec<HumanAdvanced>,
-    bank: HashMap<u32, usize>,
-}
-
-
-#[allow(dead_code)]
-fn random_testing() {
-    let mut buf = Vec::new();
-    let john = HumanAdvanced {
-        id: 0,
-        age: 42,
-        name: "John".into(),
-        fav_color: Color::Green,
-    };
-
-    john.serialize(&mut Serializer::new(&mut buf)).unwrap();
-
-    println!("{:?}", buf);
-    let new_val: HumanAdvanced = rmp_serde::from_slice(&buf).expect("deserialization failed");
-    let rmpv_val: rmpv::Value = rmp_serde::from_slice(&buf).expect("serialization into val failed");
-    println!("RMPV value: {:?}", rmpv_val);
-    let json_str = serde_json::to_string(&rmpv_val).expect("creating json failed");
-    assert_eq!(john, new_val);
-    println!("JSON str: {}", json_str);
-    let val_test: HumanAdvanced = serde_json::from_str(&json_str).expect("wild");
-    println!("val test: {:?}", val_test);
-
-    let nadine = HumanAdvanced {
-        id: 1,
-        age: 24,
-        name: "Nadine".into(),
-        fav_color: Color::Red,
-    };
-    let mut bank = HashMap::default();
-    bank.insert(john.id, 1000000);
-    bank.insert(nadine.id, 1);
-
-    let human_group = HumanGroup {
-        humans: vec![john, nadine.clone()],
-        bank,
-    };
-    let json_str = serde_json::to_string(&nadine).unwrap();
-    println!("Nadine as JSON: {}", json_str);
-
-    let nadine_is_back: HumanAdvanced = serde_json::from_str(&json_str).unwrap();
-    println!("nadine deserialized: {:?}", nadine_is_back);
-
-    let human_group_json = serde_json::to_string(&human_group).unwrap();
-    println!("human group: {}", human_group_json);
-    println!("human group json size: {}", human_group_json.len());
-
-    let human_group_rmp_vec = rmp_serde::to_vec_named(&human_group_json).unwrap();
-    println!("human group msg pack size: {:?}", human_group_rmp_vec.len());
-}
-
-#[allow(dead_code)]
-fn send_back_weird_stuff(buf: &[u8], received: usize, socket: &UdpSocket, src: SocketAddr) {
-    let human_from_python: rmpv::Value = rmp_serde::from_slice(&buf[..received]).expect("blablah");
-    let human_attempt_2: Human = rmp_serde::from_slice(&buf[..received]).expect("blhfwhfw");
-    println!("human from python: {}", human_from_python);
-    println!("human 2 from python: {:?}", human_attempt_2);
-    let send_back_human = rmp_serde::to_vec_named(&human_attempt_2).expect("k32k323k2");
-    socket
-        .send_to(&send_back_human, src)
-        .expect("sending back failed");
-}

serialization-prototyping/src/main.rs

@@ -1,61 +0,0 @@
-#![allow(unused_imports)]
-use rmp_serde::{Deserializer, Serializer};
-use satrs_minisim::eps::{SwitchMap, SwitchMapWrapper};
-use serde::{Deserialize, Serialize};
-use std::{
-    collections::HashMap,
-    net::{SocketAddr, UdpSocket},
-};
-
-#[derive(Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
-pub struct SwitchSet {
-    pub valid: bool,
-    pub switch_map: SwitchMap,
-}
-
-pub struct UdpServer {
-    socket: UdpSocket,
-    last_sender: Option<SocketAddr>,
-}
-
-impl Default for UdpServer {
-    fn default() -> Self {
-        UdpServer {
-            socket: UdpSocket::bind("127.0.0.1:7301").expect("binding UDP socket failed"),
-            last_sender: Default::default(),
-        }
-    }
-}
-
-impl UdpServer {
-    pub fn send_back_reply(&self, reply: &[u8]) {
-        self.socket
-            .send_to(reply, self.last_sender.expect("last sender not set"))
-            .expect("sending back failed");
-    }
-}
-
-fn main() {
-    let mut udp_server = UdpServer::default();
-
-    loop {
-        // Receives a single datagram message on the socket. If `buf` is too small to hold
-        // the message, it will be cut off.
-        let mut buf = [0; 4096];
-        let (received, src) = udp_server
-            .socket
-            .recv_from(&mut buf)
-            .expect("receive call failed");
-        udp_server.last_sender = Some(src);
-        println!("received {} bytes from {:?}", received, src);
-        let switch_map_off = SwitchMapWrapper::default();
-        let switch_set = SwitchSet {
-            valid: true,
-            switch_map: switch_map_off.0.clone(),
-        };
-        let switch_map_off_json =
-            serde_json::to_string(&switch_set).expect("json serialization failed");
-        println!("sending back reply: {}", switch_map_off_json);
-        udp_server.send_back_reply(switch_map_off_json.as_bytes());
-    }
-}