Merge pull request 'Package renaming and TMTC client' (#23) from add_tmtccmd_tmtc_client_rename_crate into main

Reviewed-on: rust/satrs-launchpad#23

.idea/runConfigurations/Run_obsw_example.xml

@@ -1,6 +1,6 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run obsw example" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
-    <option name="command" value="run --package fsrc-example --bin obsw" />
+    <option name="command" value="run -p satrs-example --bin satrs-example" />
     <option name="workingDirectory" value="file://$PROJECT_DIR$" />
     <option name="channel" value="DEFAULT" />
     <option name="requiredFeatures" value="true" />

.idea/runConfigurations/Run_obsw_simple_client.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run obsw client example" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
+  <configuration default="false" name="Run obsw simple client" type="CargoCommandRunConfiguration" factoryName="Cargo Command">
     <option name="command" value="run --package fsrc-example --bin client" />
     <option name="workingDirectory" value="file://$PROJECT_DIR$" />
     <option name="channel" value="DEFAULT" />

Cargo.lock

@@ -205,9 +205,9 @@ dependencies = [
 
 [[package]]
 name = "crossbeam-utils"
-version = "0.8.12"
+version = "0.8.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "edbafec5fa1f196ca66527c1b12c2ec4745ca14b50f1ad8f9f6f720b55d11fac"
+checksum = "422f23e724af1240ec469ea1e834d87a4b59ce2efe2c6a96256b0c47e2fd86aa"
 dependencies = [
  "cfg-if",
 ]
@@ -306,37 +306,6 @@ dependencies = [
  "void",
 ]
 
-[[package]]
-name = "fsrc-core"
-version = "0.1.0"
-dependencies = [
- "bus",
- "crossbeam-channel",
- "delegate 0.8.0",
- "downcast-rs",
- "embed-doc-image",
- "hashbrown",
- "heapless",
- "num-traits",
- "once_cell",
- "paste",
- "postcard",
- "serde",
- "spacepackets",
- "zerocopy",
-]
-
-[[package]]
-name = "fsrc-example"
-version = "0.1.0"
-dependencies = [
- "crossbeam-channel",
- "delegate 0.8.0",
- "fsrc-core",
- "spacepackets",
- "zerocopy",
-]
-
 [[package]]
 name = "hash32"
 version = "0.2.1"
@@ -620,6 +589,37 @@ dependencies = [
  "semver 1.0.14",
 ]
 
+[[package]]
+name = "satrs-core"
+version = "0.1.0"
+dependencies = [
+ "bus",
+ "crossbeam-channel",
+ "delegate 0.8.0",
+ "downcast-rs",
+ "embed-doc-image",
+ "hashbrown",
+ "heapless",
+ "num-traits",
+ "once_cell",
+ "paste",
+ "postcard",
+ "serde",
+ "spacepackets",
+ "zerocopy",
+]
+
+[[package]]
+name = "satrs-example"
+version = "0.1.0"
+dependencies = [
+ "crossbeam-channel",
+ "delegate 0.8.0",
+ "satrs-core",
+ "spacepackets",
+ "zerocopy",
+]
+
 [[package]]
 name = "scopeguard"
 version = "1.1.0"

Cargo.toml

@@ -1,7 +1,7 @@
 [workspace]
 
 members = [
-    "fsrc-core",
+    "satrs-core",
     "spacepackets",
-    "fsrc-example"
+    "satrs-example"
 ]

README.md

@@ -1,5 +1,14 @@
-Rust Flight Software Framework Launchpad
+sat-rs launchpad
 =========
 
 This is the prototyping repository for the initial version of a
 Rust Flight Software Framework.
+
+Currently, it contains the following major subcrates:
+
+1. The [`spacepackets`](https://egit.irs.uni-stuttgart.de/rust/spacepackets) crate which contains
+   basic ECSS and CCSDS packet protocol implementations.
+2. The [`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core)
+   crate containing the core components of sat-rs
+3. The [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-example)
+   crate which shows a simple example on-board software using various sat-rs components.

satrs-core/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "fsrc-core"
+name = "satrs-core"
 version = "0.1.0"
 edition = "2021"
 

satrs-core/src/events.rs

@@ -18,7 +18,7 @@
 //! # Examples
 //!
 //! ```
-//! use fsrc_core::events::{EventU16, EventU32, EventU32TypedSev, Severity, SeverityHigh, SeverityInfo};
+//! use satrs_core::events::{EventU16, EventU32, EventU32TypedSev, Severity, SeverityHigh, SeverityInfo};
 //!
 //! const MSG_RECVD: EventU32TypedSev<SeverityInfo> = EventU32TypedSev::const_new(1, 0);
 //! const MSG_FAILED: EventU32 = EventU32::const_new(Severity::LOW, 1, 1);

satrs-core/src/hal/host/udp_server.rs

@@ -18,8 +18,8 @@ use std::vec::Vec;
 ///
 /// ```
 /// use std::net::{IpAddr, Ipv4Addr, SocketAddr, UdpSocket};
-/// use fsrc_core::hal::host::udp_server::UdpTcServer;
-/// use fsrc_core::tmtc::ReceivesTc;
+/// use satrs_core::hal::host::udp_server::UdpTcServer;
+/// use satrs_core::tmtc::ReceivesTc;
 /// use spacepackets::SpHeader;
 /// use spacepackets::tc::PusTc;
 ///

satrs-core/src/objects.rs

@@ -10,7 +10,7 @@
 //! ```rust
 //! use std::any::Any;
 //! use std::error::Error;
-//! use fsrc_core::objects::{ManagedSystemObject, ObjectId, ObjectManager, SystemObject};
+//! use satrs_core::objects::{ManagedSystemObject, ObjectId, ObjectManager, SystemObject};
 //!
 //! struct ExampleSysObj {
 //!     id: ObjectId,

satrs-core/src/params.rs

@@ -13,7 +13,7 @@
 //! ## Example for primitive type wrapper
 //!
 //! ```
-//! use fsrc_core::params::{ParamsRaw, ToBeBytes, U32Pair, WritableToBeBytes};
+//! use satrs_core::params::{ParamsRaw, ToBeBytes, U32Pair, WritableToBeBytes};
 //!
 //! let u32_pair = U32Pair(0x1010, 25);
 //! assert_eq!(u32_pair.0, 0x1010);

satrs-core/src/pool.rs

@@ -13,7 +13,7 @@
 //! # Example
 //!
 //! ```
-//! use fsrc_core::pool::{LocalPool, PoolCfg, PoolProvider};
+//! use satrs_core::pool::{LocalPool, PoolCfg, PoolProvider};
 //!
 //! // 4 buckets of 4 bytes, 2 of 8 bytes and 1 of 16 bytes
 //! let pool_cfg = PoolCfg::new(vec![(4, 4), (2, 8), (1, 16)]);

satrs-core/src/pus/verification.rs

@@ -15,8 +15,8 @@
 //! ```
 //! use std::sync::{Arc, RwLock};
 //! use std::time::Duration;
-//! use fsrc_core::pool::{LocalPool, PoolCfg, PoolProvider, SharedPool};
-//! use fsrc_core::pus::verification::{CrossbeamVerifSender, VerificationReporterCfg, VerificationReporterWithSender};
+//! use satrs_core::pool::{LocalPool, PoolCfg, PoolProvider, SharedPool};
+//! use satrs_core::pus::verification::{CrossbeamVerifSender, VerificationReporterCfg, VerificationReporterWithSender};
 //! use spacepackets::ecss::PusPacket;
 //! use spacepackets::SpHeader;
 //! use spacepackets::tc::{PusTc, PusTcSecondaryHeader};

satrs-core/src/tmtc/ccsds_distrib.rs

@@ -18,8 +18,8 @@
 //! # Example
 //!
 //! ```rust
-//! use fsrc_core::tmtc::ccsds_distrib::{CcsdsPacketHandler, CcsdsDistributor};
-//! use fsrc_core::tmtc::ReceivesTc;
+//! use satrs_core::tmtc::ccsds_distrib::{CcsdsPacketHandler, CcsdsDistributor};
+//! use satrs_core::tmtc::ReceivesTc;
 //! use spacepackets::{CcsdsPacket, SpHeader};
 //! use spacepackets::tc::PusTc;
 //!

satrs-core/src/tmtc/pus_distrib.rs

@@ -17,8 +17,8 @@
 //! # Example
 //!
 //! ```rust
-//! use fsrc_core::tmtc::pus_distrib::{PusDistributor, PusServiceProvider};
-//! use fsrc_core::tmtc::ReceivesTc;
+//! use satrs_core::tmtc::pus_distrib::{PusDistributor, PusServiceProvider};
+//! use satrs_core::tmtc::ReceivesTc;
 //! use spacepackets::SpHeader;
 //! use spacepackets::tc::PusTc;
 //! struct ConcretePusHandler {

satrs-core/tests/pools.rs

@@ -1,4 +1,4 @@
-use fsrc_core::pool::{LocalPool, PoolCfg, PoolGuard, PoolProvider, StoreAddr};
+use satrs_core::pool::{LocalPool, PoolCfg, PoolGuard, PoolProvider, StoreAddr};
 use std::ops::DerefMut;
 use std::sync::mpsc;
 use std::sync::mpsc::{Receiver, Sender};

satrs-core/tests/pus_autogen_events.rs

@@ -1,6 +1,6 @@
 #![allow(dead_code, unused_imports)]
 
-use fsrc_core::events::{
+use satrs_core::events::{
     EventU32, EventU32TypedSev, GenericEvent, HasSeverity, LargestEventRaw, LargestGroupIdRaw,
     Severity, SeverityInfo, SeverityLow, SeverityMedium,
 };

satrs-core/tests/pus_events.rs

@@ -1,11 +1,11 @@
-use fsrc_core::event_man::{
+use satrs_core::event_man::{
     EventManagerWithMpscQueue, MpscEventU32Receiver, MpscEventU32SendProvider, SendEventProvider,
 };
-use fsrc_core::events::{EventU32, EventU32TypedSev, Severity, SeverityInfo};
-use fsrc_core::params::U32Pair;
-use fsrc_core::params::{Params, ParamsHeapless, WritableToBeBytes};
-use fsrc_core::pus::event_man::{DefaultPusMgmtBackendProvider, EventReporter, PusEventDispatcher};
-use fsrc_core::pus::{EcssTmError, EcssTmSender};
+use satrs_core::events::{EventU32, EventU32TypedSev, Severity, SeverityInfo};
+use satrs_core::params::U32Pair;
+use satrs_core::params::{Params, ParamsHeapless, WritableToBeBytes};
+use satrs_core::pus::event_man::{DefaultPusMgmtBackendProvider, EventReporter, PusEventDispatcher};
+use satrs_core::pus::{EcssTmError, EcssTmSender};
 use spacepackets::ecss::PusPacket;
 use spacepackets::tm::PusTm;
 use std::sync::mpsc::{channel, SendError, TryRecvError};

satrs-core/tests/pus_verification.rs

@@ -1,5 +1,5 @@
-use fsrc_core::pool::{LocalPool, PoolCfg, PoolProvider, SharedPool};
-use fsrc_core::pus::verification::{
+use satrs_core::pool::{LocalPool, PoolCfg, PoolProvider, SharedPool};
+use satrs_core::pus::verification::{
     CrossbeamVerifSender, FailParams, RequestId, VerificationReporterCfg,
     VerificationReporterWithSender,
 };

satrs-example/Cargo.toml

@@ -1,8 +1,9 @@
 [package]
-name = "fsrc-example"
+name = "satrs-example"
 version = "0.1.0"
 edition = "2021"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
+default-run = "satrs-example"
 
 [dependencies]
 crossbeam-channel = "0.5"
@@ -12,5 +13,5 @@ zerocopy = "0.6"
 [dependencies.spacepackets]
 path = "../spacepackets"
 
-[dependencies.fsrc-core]
-path = "../fsrc-core"
+[dependencies.satrs-core]
+path = "../satrs-core"

satrs-example/README.md

@@ -0,0 +1,45 @@
+sat-rs example
+======
+
+This crate contains an example application which simulates an on-board software.
+It uses various components provided by the sat-rs framework to do this. As such, it shows how
+a more complex real on-board software could be built from these components.
+The application opens a UDP server on port 7301 to receive telecommands.
+
+You can run the application using `cargo run`. The `simpleclient` binary target sends a
+ping telecommand and then verifies the telemetry generated by the example application.
+It can be run like this:
+
+```rs
+cargo run --bin simpleclient
+```
+
+This repository also contains a more complex client using the
+[Python tmtccmd](https://github.com/robamu-org/tmtccmd) module.
+
+# Using the tmtccmd Python client
+
+The python client requires a valid installation of the
+[tmtccmd package](https://github.com/robamu-org/tmtccmd).
+
+It is recommended to use a virtual environment to do this. To set up one in the command line,
+you can use `python3 -m venv venv` on Unix systems or `py -m venv venv` on Windows systems.
+After doing this, you can check the [venv tutorial](https://docs.python.org/3/tutorial/venv.html)
+on how to activate the environment and then use the following command to install the required
+dependency:
+
+```sh
+pip install -r requirements.txt
+```
+
+Alternatively, if you would like to use the GUI functionality provided by `tmtccmd`, you can also
+install it manually with
+
+```sh
+pip install tmtccmd[gui]
+```
+
+After setting up the dependencies, you can simply run the `main.py` script to send commands
+to the OBSW example and to view and handle incoming telemetry. The script and the `tmtccmd`
+framework it uses allow to easily add and expose additional telecommand and telemetry handling
+as Python code.

satrs-example/pyclient/.gitignore

@@ -0,0 +1,6 @@
+/venv
+/log
+/.idea/*
+!/.idea/runConfigurations
+
+/seqcnt.txt

satrs-example/pyclient/main.py

@@ -0,0 +1,277 @@
+#!/usr/bin/env python3
+"""Example client for the sat-rs example application"""
+import sys
+import time
+from typing import Optional
+
+import tmtccmd
+from spacepackets.ecss import PusTelemetry, PusTelecommand, PusVerificator
+from spacepackets.ecss.pus_17_test import Service17Tm
+from spacepackets.ecss.pus_1_verification import UnpackParams, Service1Tm
+from spacepackets.util import UnsignedByteField
+
+from tmtccmd import CcsdsTmtcBackend, TcHandlerBase, ProcedureParamsWrapper
+from tmtccmd.core.base import BackendRequest
+from tmtccmd.pus import VerificationWrapper
+from tmtccmd.tm import CcsdsTmHandler, SpecificApidHandlerBase
+from tmtccmd.com_if import ComInterface
+from tmtccmd.config import (
+    default_json_path,
+    SetupParams,
+    TmTcCfgHookBase,
+    TmtcDefinitionWrapper,
+    CoreServiceList,
+    OpCodeEntry,
+    params_to_procedure_conversion,
+)
+from tmtccmd.config import PreArgsParsingWrapper, SetupWrapper
+from tmtccmd.logging import get_console_logger
+from tmtccmd.logging.pus import (
+    RegularTmtcLogWrapper,
+    RawTmtcTimedLogWrapper,
+    TimedLogWhen,
+)
+from tmtccmd.tc import (
+    TcQueueEntryType,
+    ProcedureWrapper,
+    TcProcedureType,
+    FeedWrapper,
+    SendCbParams,
+    DefaultPusQueueHelper,
+)
+from tmtccmd.tm.pus_5_event import Service5Tm
+from tmtccmd.util import FileSeqCountProvider, PusFileSeqCountProvider
+from tmtccmd.util.obj_id import ObjectIdDictT
+
+from tmtccmd.util.tmtc_printer import FsfwTmTcPrinter
+
+LOGGER = get_console_logger()
+
+EXAMPLE_PUS_APID = 0x02
+
+
+class SatRsConfigHook(TmTcCfgHookBase):
+    def __init__(self, json_cfg_path: str):
+        super().__init__(json_cfg_path=json_cfg_path)
+
+    def assign_communication_interface(self, com_if_key: str) -> Optional[ComInterface]:
+        print("Communication interface assignment function was called")
+        from tmtccmd.config.com_if import (
+            create_com_interface_default,
+            create_com_interface_cfg_default,
+        )
+
+        cfg = create_com_interface_cfg_default(
+            com_if_key=com_if_key,
+            json_cfg_path=self.cfg_path,
+            space_packet_ids=None,
+        )
+        return create_com_interface_default(cfg)
+
+    def get_tmtc_definitions(self) -> TmtcDefinitionWrapper:
+        from tmtccmd.config.globals import get_default_tmtc_defs
+
+        defs = get_default_tmtc_defs()
+        srv_5 = OpCodeEntry()
+        srv_5.add("0", "Event Test")
+        defs.add_service(
+            name=CoreServiceList.SERVICE_5.value,
+            info="PUS Service 5 Event",
+            op_code_entry=srv_5,
+        )
+        srv_17 = OpCodeEntry()
+        srv_17.add("0", "Ping Test")
+        defs.add_service(
+            name=CoreServiceList.SERVICE_17_ALT,
+            info="PUS Service 17 Test",
+            op_code_entry=srv_17,
+        )
+        return defs
+
+    def perform_mode_operation(self, tmtc_backend: CcsdsTmtcBackend, mode: int):
+        LOGGER.info("Mode operation hook was called")
+        pass
+
+    def get_object_ids(self) -> ObjectIdDictT:
+        from tmtccmd.config.objects import get_core_object_ids
+
+        return get_core_object_ids()
+
+
+class PusHandler(SpecificApidHandlerBase):
+    def __init__(
+        self,
+        verif_wrapper: VerificationWrapper,
+        printer: FsfwTmTcPrinter,
+        raw_logger: RawTmtcTimedLogWrapper,
+    ):
+        super().__init__(EXAMPLE_PUS_APID, None)
+        self.printer = printer
+        self.raw_logger = raw_logger
+        self.verif_wrapper = verif_wrapper
+
+    def handle_tm(self, packet: bytes, _user_args: any):
+        try:
+            tm_packet = PusTelemetry.unpack(packet)
+        except ValueError as e:
+            LOGGER.warning("Could not generate PUS TM object from raw data")
+            LOGGER.warning(f"Raw Packet: [{packet.hex(sep=',')}], REPR: {packet!r}")
+            raise e
+        service = tm_packet.service
+        dedicated_handler = False
+        if service == 1:
+            tm_packet = Service1Tm.unpack(data=packet, params=UnpackParams(1, 2))
+            res = self.verif_wrapper.add_tm(tm_packet)
+            if res is None:
+                LOGGER.info(
+                    f"Received Verification TM[{tm_packet.service}, {tm_packet.subservice}] "
+                    f"with Request ID {tm_packet.tc_req_id.as_u32():#08x}"
+                )
+                LOGGER.warning(
+                    f"No matching telecommand found for {tm_packet.tc_req_id}"
+                )
+            else:
+                self.verif_wrapper.log_to_console(tm_packet, res)
+                self.verif_wrapper.log_to_file(tm_packet, res)
+            dedicated_handler = True
+        if service == 5:
+            tm_packet = Service5Tm.unpack(packet)
+        if service == 17:
+            tm_packet = Service17Tm.unpack(packet)
+            dedicated_handler = True
+            if tm_packet.subservice == 2:
+                self.printer.file_logger.info("Received Ping Reply TM[17,2]")
+                LOGGER.info("Received Ping Reply TM[17,2]")
+            else:
+                self.printer.file_logger.info(
+                    f"Received Test Packet with unknown subservice {tm_packet.subservice}"
+                )
+                LOGGER.info(
+                    f"Received Test Packet with unknown subservice {tm_packet.subservice}"
+                )
+        if tm_packet is None:
+            LOGGER.info(
+                f"The service {service} is not implemented in Telemetry Factory"
+            )
+            tm_packet = PusTelemetry.unpack(packet)
+        self.raw_logger.log_tm(tm_packet)
+        if not dedicated_handler and tm_packet is not None:
+            self.printer.handle_long_tm_print(packet_if=tm_packet, info_if=tm_packet)
+
+
+class TcHandler(TcHandlerBase):
+    def __init__(
+        self,
+        seq_count_provider: FileSeqCountProvider,
+        verif_wrapper: VerificationWrapper,
+    ):
+        super(TcHandler, self).__init__()
+        self.seq_count_provider = seq_count_provider
+        self.verif_wrapper = verif_wrapper
+        self.queue_helper = DefaultPusQueueHelper(
+            queue_wrapper=None,
+            seq_cnt_provider=seq_count_provider,
+        )
+
+    def send_cb(self, send_params: SendCbParams):
+        entry_helper = send_params.entry
+        if entry_helper.is_tc:
+            if entry_helper.entry_type == TcQueueEntryType.PUS_TC:
+                pus_tc_wrapper = entry_helper.to_pus_tc_entry()
+                pus_tc_wrapper.pus_tc.seq_count = (
+                    self.seq_count_provider.get_and_increment()
+                )
+                self.verif_wrapper.add_tc(pus_tc_wrapper.pus_tc)
+                raw_tc = pus_tc_wrapper.pus_tc.pack()
+                LOGGER.info(f"Sending {pus_tc_wrapper.pus_tc}")
+                send_params.com_if.send(raw_tc)
+        elif entry_helper.entry_type == TcQueueEntryType.LOG:
+            log_entry = entry_helper.to_log_entry()
+            LOGGER.info(log_entry.log_str)
+
+    def queue_finished_cb(self, helper: ProcedureWrapper):
+        if helper.proc_type == TcProcedureType.DEFAULT:
+            def_proc = helper.to_def_procedure()
+            LOGGER.info(
+                f"Queue handling finished for service {def_proc.service} and "
+                f"op code {def_proc.op_code}"
+            )
+
+    def feed_cb(self, helper: ProcedureWrapper, wrapper: FeedWrapper):
+        self.queue_helper.queue_wrapper = wrapper.queue_wrapper
+        if helper.proc_type == TcProcedureType.DEFAULT:
+            def_proc = helper.to_def_procedure()
+            service = def_proc.service
+            if (
+                service == CoreServiceList.SERVICE_17
+                or service == CoreServiceList.SERVICE_17_ALT
+            ):
+                return self.queue_helper.add_pus_tc(
+                    PusTelecommand(service=17, subservice=1)
+                )
+
+
+def main():
+    tmtccmd.init_printout(False)
+    hook_obj = SatRsConfigHook(json_cfg_path=default_json_path())
+    parser_wrapper = PreArgsParsingWrapper()
+    parser_wrapper.create_default_parent_parser()
+    parser_wrapper.create_default_parser()
+    parser_wrapper.add_def_proc_args()
+    post_args_wrapper = parser_wrapper.parse(hook_obj)
+    params = SetupParams()
+    proc_wrapper = ProcedureParamsWrapper()
+    if post_args_wrapper.use_gui:
+        post_args_wrapper.set_params_without_prompts(params, proc_wrapper)
+    else:
+        post_args_wrapper.set_params_with_prompts(params, proc_wrapper)
+    params.apid = EXAMPLE_PUS_APID
+    setup_args = SetupWrapper(
+        hook_obj=hook_obj, setup_params=params, proc_param_wrapper=proc_wrapper
+    )
+    # Create console logger helper and file loggers
+    tmtc_logger = RegularTmtcLogWrapper()
+    printer = FsfwTmTcPrinter(tmtc_logger.logger)
+    raw_logger = RawTmtcTimedLogWrapper(when=TimedLogWhen.PER_HOUR, interval=1)
+    verificator = PusVerificator()
+    verification_wrapper = VerificationWrapper(verificator, LOGGER, printer.file_logger)
+    # Create primary TM handler and add it to the CCSDS Packet Handler
+    tm_handler = PusHandler(verification_wrapper, printer, raw_logger)
+    ccsds_handler = CcsdsTmHandler(generic_handler=None)
+    ccsds_handler.add_apid_handler(tm_handler)
+
+    # Create TC handler
+    seq_count_provider = PusFileSeqCountProvider()
+    tc_handler = TcHandler(seq_count_provider, verification_wrapper)
+    tmtccmd.setup(setup_args=setup_args)
+    init_proc = params_to_procedure_conversion(setup_args.proc_param_wrapper)
+    tmtc_backend = tmtccmd.create_default_tmtc_backend(
+        setup_wrapper=setup_args,
+        tm_handler=ccsds_handler,
+        tc_handler=tc_handler,
+        init_procedure=init_proc,
+    )
+    tmtccmd.start(tmtc_backend=tmtc_backend, hook_obj=hook_obj)
+    try:
+        while True:
+            state = tmtc_backend.periodic_op(None)
+            if state.request == BackendRequest.TERMINATION_NO_ERROR:
+                sys.exit(0)
+            elif state.request == BackendRequest.DELAY_IDLE:
+                LOGGER.info("TMTC Client in IDLE mode")
+                time.sleep(3.0)
+            elif state.request == BackendRequest.DELAY_LISTENER:
+                time.sleep(0.8)
+            elif state.request == BackendRequest.DELAY_CUSTOM:
+                if state.next_delay.total_seconds() <= 0.4:
+                    time.sleep(state.next_delay.total_seconds())
+                else:
+                    time.sleep(0.4)
+            elif state.request == BackendRequest.CALL_NEXT:
+                pass
+    except KeyboardInterrupt:
+        sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

satrs-example/pyclient/requirements.txt

@@ -0,0 +1 @@
+tmtccmd == 3.0.0rc2

satrs-example/pyclient/tmtc_conf.json

@@ -0,0 +1,6 @@
+{
+    "com_if": "udp",
+    "tcpip_udp_ip_addr": "127.0.0.1",
+    "tcpip_udp_port": 7301,
+    "tcpip_udp_recv_max_size": 1500
+}

satrs-example/src/bin/simpleclient.rs

@@ -1,5 +1,5 @@
-use fsrc_core::pus::verification::RequestId;
-use fsrc_example::{OBSW_SERVER_ADDR, SERVER_PORT};
+use satrs_core::pus::verification::RequestId;
+use satrs_example::{OBSW_SERVER_ADDR, SERVER_PORT};
 use spacepackets::ecss::PusPacket;
 use spacepackets::tc::PusTc;
 use spacepackets::tm::PusTm;

satrs-example/src/ccsds.rs

@@ -1,5 +1,5 @@
 use crate::tmtc::PUS_APID;
-use fsrc_core::tmtc::{CcsdsPacketHandler, PusDistributor, ReceivesCcsdsTc};
+use satrs_core::tmtc::{CcsdsPacketHandler, PusDistributor, ReceivesCcsdsTc};
 use spacepackets::{CcsdsPacket, SpHeader};
 
 pub struct CcsdsReceiver {
@@ -28,10 +28,10 @@ impl CcsdsPacketHandler for CcsdsReceiver {
 
     fn handle_unknown_apid(
         &mut self,
-        _sp_header: &SpHeader,
+        sp_header: &SpHeader,
         _tc_raw: &[u8],
     ) -> Result<(), Self::Error> {
-        println!("Unknown APID detected");
+        println!("Unknown APID 0x{:x?} detected", sp_header.apid());
         Ok(())
     }
 }

satrs-example/src/main.rs

@@ -3,22 +3,22 @@ mod pus;
 mod tmtc;
 
 use crate::tmtc::{core_tmtc_task, CoreTmtcArgs, TmStore, PUS_APID};
-use fsrc_core::event_man::{
+use satrs_core::event_man::{
     EventManagerWithMpscQueue, MpscEventReceiver, MpscEventU32SendProvider, SendEventProvider,
 };
-use fsrc_core::events::EventU32;
-use fsrc_core::hal::host::udp_server::UdpTcServer;
-use fsrc_core::pool::{LocalPool, PoolCfg, SharedPool, StoreAddr};
-use fsrc_core::pus::event_man::{
+use satrs_core::events::EventU32;
+use satrs_core::hal::host::udp_server::UdpTcServer;
+use satrs_core::pool::{LocalPool, PoolCfg, SharedPool, StoreAddr};
+use satrs_core::pus::event_man::{
     DefaultPusMgmtBackendProvider, EventReporter, EventRequest, EventRequestWithToken,
     PusEventDispatcher,
 };
-use fsrc_core::pus::verification::{
+use satrs_core::pus::verification::{
     MpscVerifSender, VerificationReporterCfg, VerificationReporterWithSender,
 };
-use fsrc_core::pus::{EcssTmError, EcssTmSender};
-use fsrc_core::tmtc::CcsdsError;
-use fsrc_example::{OBSW_SERVER_ADDR, SERVER_PORT};
+use satrs_core::pus::{EcssTmError, EcssTmSender};
+use satrs_core::tmtc::CcsdsError;
+use satrs_example::{OBSW_SERVER_ADDR, SERVER_PORT};
 use spacepackets::time::{CdsShortTimeProvider, TimeWriter};
 use spacepackets::tm::PusTm;
 use std::net::{IpAddr, SocketAddr};
@@ -100,10 +100,13 @@ fn main() {
         event_sender,
         event_request_tx,
     };
+
+    println!("Starting TMTC task");
     let jh0 = thread::spawn(move || {
         core_tmtc_task(core_args, tm_server_rx, addr, reporter_with_sender_0);
     });
 
+    println!("Starting TM funnel task");
     let jh1 = thread::spawn(move || {
         let tm_funnel = TmFunnel {
             tm_server_tx,
@@ -119,6 +122,7 @@ fn main() {
         }
     });
 
+    println!("Starting event handling task");
     let jh2 = thread::spawn(move || {
         let mut timestamp: [u8; 7] = [0; 7];
         let mut sender = EventTmSender::new(tm_store_helper, tm_funnel_tx);

satrs-example/src/pus.rs

@@ -1,13 +1,13 @@
 use crate::tmtc::TmStore;
-use fsrc_core::events::EventU32;
-use fsrc_core::pool::StoreAddr;
-use fsrc_core::pus::event::Subservices;
-use fsrc_core::pus::event_man::{EventRequest, EventRequestWithToken};
-use fsrc_core::pus::verification::{
+use satrs_core::events::EventU32;
+use satrs_core::pool::StoreAddr;
+use satrs_core::pus::event::Subservices;
+use satrs_core::pus::event_man::{EventRequest, EventRequestWithToken};
+use satrs_core::pus::verification::{
     FailParams, SharedStdVerifReporterWithSender, TcStateAccepted, VerificationToken,
 };
-use fsrc_core::tmtc::tm_helper::PusTmWithCdsShortHelper;
-use fsrc_core::tmtc::PusServiceProvider;
+use satrs_core::tmtc::tm_helper::PusTmWithCdsShortHelper;
+use satrs_core::tmtc::PusServiceProvider;
 use spacepackets::ecss::{EcssEnumU16, PusPacket};
 use spacepackets::tc::PusTc;
 use spacepackets::time::{CdsShortTimeProvider, TimeWriter};

satrs-example/src/tmtc.rs

@@ -1,6 +1,6 @@
-use fsrc_core::events::EventU32;
-use fsrc_core::hal::host::udp_server::{ReceiveResult, UdpTcServer};
-use fsrc_core::params::Params;
+use satrs_core::events::EventU32;
+use satrs_core::hal::host::udp_server::{ReceiveResult, UdpTcServer};
+use satrs_core::params::Params;
 use std::net::SocketAddr;
 use std::sync::mpsc;
 use std::sync::mpsc::Sender;
@@ -10,10 +10,10 @@ use std::time::Duration;
 use crate::ccsds::CcsdsReceiver;
 use crate::pus::PusReceiver;
 use crate::UdpTmtcServer;
-use fsrc_core::pool::{SharedPool, StoreAddr};
-use fsrc_core::pus::event_man::EventRequestWithToken;
-use fsrc_core::pus::verification::SharedStdVerifReporterWithSender;
-use fsrc_core::tmtc::{CcsdsDistributor, CcsdsError, PusDistributor};
+use satrs_core::pool::{SharedPool, StoreAddr};
+use satrs_core::pus::event_man::EventRequestWithToken;
+use satrs_core::pus::verification::SharedStdVerifReporterWithSender;
+use satrs_core::tmtc::{CcsdsDistributor, CcsdsError, PusDistributor};
 use spacepackets::tm::PusTm;
 
 pub const PUS_APID: u16 = 0x02;

spacepackets

@@ -1 +1 @@
-Subproject commit c750f94fba31114c5ade530ea6235acb6bb8835a
+Subproject commit 1ec21c1bff69a04b9112c66bec39cb0acb3412be