fix(SmurfCommand.save_state): Use the new process class.

In rogue 6, long running commands will time out. Use the
process implementation and instead and monitor for completion.

Author: tristpinsm

python/pysmurf/client/command/smurf_command.py

@@ -17,6 +17,7 @@
 import os
 import time
 import subprocess
+from typing import Literal
 
 import numpy as np
 from packaging import version
@@ -1199,7 +1200,38 @@ def sel_ext_ref(self, bay, **kwargs):
 
     # name changed in Rogue 4 from WriteState to SaveState.  Keeping
     # the write_state function for backwards compatibilty.
-    _save_state_reg = "AMCc.SaveState"
+    # In rogue 6 this has moved to a process to avoid timing out
+    # on a long-running command
+    _save_state_reg = "AMCc.SaveConfigProcess"
+
+    def _save_state_or_config(
+        self, fname :  str, mode : Literal["Config", "Status"], timeout : float = 180.0,
+        **kwargs
+    ):
+        # write out to a file
+        self._caput(self._save_state_reg + ".SaveMode", "File", **kwargs)
+        self._caput(self._save_state_reg + ".ConfigFile", fname, **kwargs)
+
+        # select state or config
+        self._caput(self._save_state_reg + ".DataType", mode, **kwargs)
+
+        # start the process
+        self._caput(self._save_state_reg + ".Start", 1, **kwargs)
+
+        # wait for process to complete
+        start = time.time()
+
+        def keep_waiting():
+            if (timeout == 0) or ((time.time() - start) <= timeout):
+                return True
+            raise TimeoutError(f"SaveConfigProcess timed out after {timeout}s.")
+
+        while self._caget(self._save_state_reg + ".Running") and keep_waiting():
+            time.sleep(0.1)
+        # Check the return value from 'LoadConfig'.
+        msg = self._caget(self._save_state_reg + ".Message")
+        if msg != "Done":
+            raise RuntimeError(f"SaveConfigProcess failed with '{msg}'")
 
     def save_state(self, val, **kwargs):
         """
@@ -1210,15 +1242,13 @@ def save_state(self, val, **kwargs):
         val : str
             The path (including file name) to write the yml file to.
         """
-        self._caput(self._save_state_reg, val, **kwargs)
+        self._save_state_or_config(val, "Status", **kwargs)
 
     # alias older rogue 3 write_state function to save_state
     write_state = save_state
 
     # name changed in Rogue 4 from WriteConfig to SaveConfig.  Keeping
     # the write_config function for backwards compatibilty.
-    _save_config_reg = "AMCc.SaveConfig"
-
     def save_config(self, val, **kwargs):
         """
         Writes the current (un-masked) PyRogue settings to a yml file.
@@ -1228,7 +1258,7 @@ def save_config(self, val, **kwargs):
         val : str
             The path (including file name) to write the yml file to.
         """
-        self._caput(self._save_config_reg, val, **kwargs)
+        self._save_state_or_config(val, "Config", **kwargs)
 
     # alias older rogue 3 write_config function to save_config
     write_config = save_config

python/pysmurf/core/roots/Common.py

@@ -153,6 +153,8 @@ def __init__(self, *,
                 pyrogue.streamConnect(self._ddr_streams[i], self._stream_fifos[i])
 
 
+        # Note that these are no longer exposed in the SmurfCommand interface.
+        # Instead, the SaveConfigProcess is called, which WILL read before saving.
         # Update SaveState to not read before saving
         self.SaveState.replaceFunction(lambda arg: self.saveYaml(name=arg,
                                                                  readFirst=False,