Add cooldown option for file uplink (#272)

* Add cooldown to FileUplinker

* Extend timeout

* Bump default file cooldown to 500ms

* Make cooldown a CLI argument

* Add 'cooldown' to spelling expect list

* Change default file uplink cooldown to 0

* Change default cooldown value in uplinker constructor

Updated cooldown parameter default value from 0.5 to 0.0.

Author: LeStarch

.github/actions/spelling/expect.txt

@@ -68,6 +68,7 @@ combuffer
 commandsi
 configs
 Consolas
+cooldown
 creatingdocsetswithdoxygen
 csum
 ctx

src/fprime_gds/common/files/uplinker.py

@@ -149,7 +149,7 @@ class FileUplinker(fprime_gds.common.handlers.DataHandler):
 
     CHUNK_SIZE = 256
 
-    def __init__(self, file_encoder, chunk=CHUNK_SIZE, timeout=20):
+    def __init__(self, file_encoder, chunk=CHUNK_SIZE, timeout=20, cooldown=0.0):
         """
         Constructor to build the file uplinker.
         """
@@ -163,6 +163,7 @@ def __init__(self, file_encoder, chunk=CHUNK_SIZE, timeout=20):
         self.__expected = []
         self.__timeout = Timeout()
         self.__timeout.setup(self.timeout, timeout)
+        self.cooldown = cooldown
 
     def enqueue(self, filepath, destination=None):
         """
@@ -273,6 +274,7 @@ def data_callback(self, data, sender=None):
         # Ignore handshakes not for us
         if not self.valid_handshake(data):
             return
+
         # If it is an end-wait or a cancel state, respond without reading next chunk
         if self.state == FileStates.END_WAIT:
             self.active.state = (
@@ -286,6 +288,7 @@ def data_callback(self, data, sender=None):
             self.send(CancelPacketData(self.get_next_sequence()))
             self.finish()
             return
+        time.sleep(self.cooldown)
         # Read next chunk of data.  b'' means the file is empty
         outgoing = self.active.read(self.chunk)
         if outgoing == b"":

src/fprime_gds/common/pipeline/files.py

@@ -25,7 +25,7 @@ def __init__(self):
         self.__downlinker = None
 
     def setup_file_handling(
-        self, down_store, file_encoder, file_decoder, distributor, log_dir
+        self, down_store, file_encoder, file_decoder, distributor, log_dir, cooldown=0.5
     ):
         """
         Sets up the file handling (uplink and downlink) from a pair of encoders and decoders.
@@ -36,8 +36,9 @@ def setup_file_handling(
         :param file_decoder: file decoder for downlink
         :param distributor: data distributor to register handshaking to
         :param log_dir: log directory to output downlink logs
+        :param cooldown: cooldown period between uplink packets
         """
-        self.__uplinker = fprime_gds.common.files.uplinker.FileUplinker(file_encoder)
+        self.__uplinker = fprime_gds.common.files.uplinker.FileUplinker(file_encoder, cooldown=cooldown)
         self.__downlinker = fprime_gds.common.files.downlinker.FileDownlinker(
             down_store, log_dir=log_dir
         )

src/fprime_gds/common/pipeline/standard.py

@@ -62,6 +62,7 @@ def setup(
         file_store,
         logging_prefix=None,
         data_logging_enabled=True,
+        cooldown=0.5,
     ):
         """
         Setup the standard pipeline for moving data from the middleware layer through the GDS layers using the standard
@@ -72,6 +73,7 @@ def setup(
         :param file_store: uplink/downlink storage directory
         :param logging_prefix: logging prefix. Defaults to not logging at all.
         :param packet_spec: location of packetized telemetry XML specification.
+        :param cooldown: cooldown period between file uplink packets
         """
         self.distributor = fprime_gds.common.distributor.distributor.Distributor()
         self.client_socket = self.__transport_type()
@@ -96,6 +98,7 @@ def setup(
             self.coders.file_decoder,
             self.distributor,
             logging_prefix,
+            cooldown=cooldown,
         )
         # Register distributor to client socket
         self.client_socket.register(self.distributor)

src/fprime_gds/executables/cli.py

@@ -1083,6 +1083,14 @@ def get_arguments(self) -> Dict[Tuple[str, ...], Dict[str, Any]]:
                 "type": str,
                 "help": "Directory to save command sequence binaries, on the remote FSW. Default: %(default)s",
             },
+            ("--file-uplink-cooldown",): {
+                "dest": "file_uplink_cooldown",
+                "action": "store",
+                "default": 0,
+                "required": False,
+                "type": float,
+                "help": "Cooldown period between file uplink packets. Default: %(default)s S",
+            },
         }
 
     def handle_arguments(self, args, **kwargs):
@@ -1121,6 +1129,7 @@ def pipeline_factory(args_ns, pipeline=None) -> StandardPipeline:
             "file_store": args_ns.files_storage_directory,
             "logging_prefix": args_ns.logs,
             "data_logging_enabled": not args_ns.disable_data_logging,
+            "cooldown": args_ns.file_uplink_cooldown,
         }
         pipeline = pipeline if pipeline else StandardPipeline()
         pipeline.transport_implementation = args_ns.connection_transport