test: add test for controller to call destroy controller.off

csaxs_bec/bec_ipython_client/plugins/flomni/gui_tools.py

@@ -20,7 +20,6 @@ class flomniGuiTools:
     def __init__(self):
         self.text_box = None
         self.progressbar = None
-        self.pdf_viewer = None
 
     def set_client(self, client):
         self.client = client
@@ -92,13 +91,12 @@ class flomniGuiTools:
                 print("Cannot open camera_overview. Device does not exist.")
 
     def flomnigui_remove_all_docks(self):
-        dev.cam_flomni_overview.stop_live_mode()
-        dev.cam_flomni_gripper.stop_live_mode()
-        dev.cam_xeye.live_mode = False
+        #dev.cam_flomni_overview.stop_live_mode()
+        #dev.cam_flomni_gripper.stop_live_mode()
+        #dev.cam_xeye.live_mode = False
         self.gui.flomni.delete_all() 
         self.progressbar = None
         self.text_box = None
-        self.pdf_viewer = None
 
     def flomnigui_idle(self):
         self.flomnigui_show_gui()
@@ -116,26 +114,57 @@ class flomniGuiTools:
         )
         idle_text_box.set_html_text(text)
 
-    def flomnigui_docs(self):
-
+    def flomnigui_docs(self, filename: str | None = None):
         import csaxs_bec
         from pathlib import Path
 
-        # Ensure this is a Path object, not a string
-        csaxs_bec_basepath = Path(csaxs_bec.__file__)
+        print("The general flOMNI documentation is at \nhttps://sls-csaxs.readthedocs.io/en/latest/user/ptychography/flomni.html#user-ptychography-flomni")
 
-        pdf_file = "FZP_flomni_with_CS.pdf"
+        csaxs_bec_basepath = Path(csaxs_bec.__file__).parent
+        docs_folder = (
+            csaxs_bec_basepath /
+            "bec_ipython_client" / "plugins" / "flomni" / "docs"
+        )
 
-        # Build the absolute path correctly
-        pdf_file = (
-            csaxs_bec_basepath.parent / 'bec_ipython_client' / 'plugins' / 'flomni' / 'docs' / pdf_file
-        ).resolve()
+        if not docs_folder.is_dir():
+            raise NotADirectoryError(f"Docs folder not found: {docs_folder}")
 
-        if self.pdf_viewer is None:
-            self.flomnigui_show_gui()
+        pdfs = sorted(docs_folder.glob("*.pdf"))
+        if not pdfs:
+            raise FileNotFoundError(f"No PDF files found in {docs_folder}")
+
+        # --- Resolve PDF ------------------------------------------------------
+        if filename is not None:
+            pdf_file = docs_folder / filename
+            if not pdf_file.exists():
+                raise FileNotFoundError(f"Requested file not found: {filename}")
+        else:
+            print("\nAvailable flOMNI documentation PDFs:\n")
+            for i, pdf in enumerate(pdfs, start=1):
+                print(f"  {i:2d}) {pdf.name}")
+            print()
+
+            while True:
+                try:
+                    choice = int(input(f"Select a file (1–{len(pdfs)}): "))
+                    if 1 <= choice <= len(pdfs):
+                        pdf_file = pdfs[choice - 1]
+                        break
+                    print(f"Enter a number between 1 and {len(pdfs)}.")
+                except ValueError:
+                    print("Invalid input. Please enter a number.")
+
+        # --- GUI handling (active existence check) ----------------------------
+        self.flomnigui_show_gui()
+
+        if self._flomnigui_check_attribute_not_exists("PdfViewerWidget"):
             self.flomnigui_remove_all_docks()
             self.pdf_viewer = self.gui.flomni.new(widget="PdfViewerWidget")
-        self.pdf_viewer.PdfViewerWidget.load_pdf(str(pdf_file))
+
+        # --- Load PDF ---------------------------------------------------------
+        self.pdf_viewer.PdfViewerWidget.load_pdf(str(pdf_file.resolve()))
+        print(f"\nLoaded: {pdf_file.name}\n")
+
 
     def _flomnicam_check_device_exists(self, device):
         try:

csaxs_bec/devices/npoint/npoint.py

@@ -442,6 +442,14 @@ class NPointAxis(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
+        self.controller.on(timeout=timeout)
+
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/fgalil_ophyd.py

@@ -212,10 +212,14 @@ class FlomniGalilMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/fupr_ophyd.py

@@ -185,10 +185,14 @@ class FuprGalilMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/galil_rio.py

@@ -0,0 +1,35 @@
+from ophyd_devices.utils.controller import Controller, threadlocked
+from ophyd_devices.utils.socket import SocketSignal
+
+from csaxs_bec.devices.omny.galil.galil_ophyd import GalilCommunicationError, retry_once
+
+
+class GalilRIO(Controller):
+
+    @threadlocked
+    def socket_put(self, val: str) -> None:
+        self.sock.put(f"{val}\r".encode())
+
+    @retry_once
+    def socket_put_confirmed(self, val: str) -> None:
+        """Send message to controller and ensure that it is received by checking that the socket receives a colon.
+
+        Args:
+            val (str): Message that should be sent to the socket
+
+        Raises:
+            GalilCommunicationError: Raised if the return value is not a colon.
+
+        """
+        return_val = self.socket_put_and_receive(val)
+        if return_val != ":":
+            raise GalilCommunicationError(
+                f"Expected return value of ':' but instead received {return_val}"
+            )
+
+
+class GalilRIOSignalBase(SocketSignal):
+    def __init__(self, signal_name, **kwargs):
+        self.signal_name = signal_name
+        super().__init__(**kwargs)
+        self.rio_controller = self.parent.rio_controller

csaxs_bec/devices/omny/galil/lgalil_ophyd.py

@@ -170,10 +170,14 @@ class LamniGalilMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/ogalil_ophyd.py

@@ -324,10 +324,14 @@ class OMNYGalilMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/sgalil_ophyd.py

@@ -530,10 +530,14 @@ class SGalilMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/rt/rt_flomni_ophyd.py

@@ -678,10 +678,14 @@ class RtFlomniMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/rt/rt_lamni_ophyd.py

@@ -588,10 +588,14 @@ class RtLamniMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/rt/rt_omny_ophyd.py

@@ -1119,10 +1119,14 @@ class RtOMNYMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
-    def wait_for_connection(self, timeout: int = 30, **kwargs) -> None:
-        """Wait for the device to be connected."""
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/smaract/smaract_ophyd.py

@@ -153,6 +153,14 @@ class SmaractMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
+    def wait_for_connection(self, timeout: float = 30.0) -> bool:
+        self.controller.on(timeout=timeout)
+
+    def destroy(self):
+        """Make sure to turn off the controller socket on destroy."""
+        self.controller.off(update_config=False)
+        return super().destroy()
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

tests/tests_devices/test_galil.py

@@ -2,9 +2,19 @@ import copy
 from unittest import mock
 
 import pytest
+from bec_server.device_server.tests.utils import DMMock
 from ophyd_devices.tests.utils import SocketMock
 
+from csaxs_bec.devices.npoint.npoint import NPointAxis, NPointController
+from csaxs_bec.devices.omny.galil.fgalil_ophyd import FlomniGalilController, FlomniGalilMotor
+from csaxs_bec.devices.omny.galil.fupr_ophyd import FuprGalilController, FuprGalilMotor
 from csaxs_bec.devices.omny.galil.lgalil_ophyd import LamniGalilController, LamniGalilMotor
+from csaxs_bec.devices.omny.galil.ogalil_ophyd import OMNYGalilController, OMNYGalilMotor
+from csaxs_bec.devices.omny.galil.sgalil_ophyd import GalilController, SGalilMotor
+from csaxs_bec.devices.omny.rt.rt_flomni_ophyd import RtFlomniController, RtFlomniMotor
+from csaxs_bec.devices.omny.rt.rt_lamni_ophyd import RtLamniController, RtLamniMotor
+from csaxs_bec.devices.omny.rt.rt_omny_ophyd import RtOMNYController, RtOMNYMotor
+from csaxs_bec.devices.smaract.smaract_ophyd import SmaractController, SmaractMotor
 
 
 @pytest.fixture(scope="function")
@@ -161,3 +171,51 @@ def test_find_reference(leyex, axis_nr, socket_put_messages, socket_get_messages
     except Exception as e:
         print(e)
     assert leyex.controller.sock.buffer_put == socket_put_messages
+
+
+def test_wait_for_connection_called():
+    """Test that wait_for_connection is called on all motors that have a socket controller."""
+    dm = DMMock()
+    testable_connections = [
+        (NPointAxis, NPointController),
+        (FlomniGalilMotor, FlomniGalilController),
+        (FuprGalilMotor, FuprGalilController),
+        (LamniGalilMotor, LamniGalilController),
+        (OMNYGalilMotor, OMNYGalilController),
+        (SGalilMotor, GalilController),
+        (RtFlomniMotor, RtFlomniController),
+        (RtLamniMotor, RtLamniController),
+        (RtOMNYMotor, RtOMNYController),
+        (SmaractMotor, SmaractController),
+    ]
+    for motor_cls, controller_cls in testable_connections:
+        # Store values to restore later
+        ctrl_axis_backup = controller_cls._axes_per_controller
+        try:
+            controller_cls._reset_controller()
+            controller_cls._axes_per_controller = 3
+
+            motor = motor_cls(
+                "C",
+                name="test_motor",
+                host="mpc2680.psi.ch",
+                port=8081,
+                socket_cls=SocketMock,
+                device_manager=dm,
+            )
+            with mock.patch.object(motor.controller, "on") as mock_on:
+
+                motor.wait_for_connection(timeout=5.0)
+                assert mock_on.call_args_list[-1] == mock.call(timeout=5.0)
+
+            # Make sure destroy calls controller off
+
+            with mock.patch.object(motor.controller, "off") as mock_off:
+                motor.destroy()
+                assert mock_off.call_count == 1
+                assert mock_off.call_args_list[0] == mock.call(update_config=False)
+                assert motor._destroyed is True
+
+        finally:
+            controller_cls._reset_controller()
+            controller_cls._axes_per_controller = ctrl_axis_backup