w

csaxs_bec/bec_ipython_client/plugins/flomni/gui_tools.py

@@ -91,9 +91,9 @@ 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
@@ -114,6 +114,58 @@ class flomniGuiTools:
         )
         idle_text_box.set_html_text(text)
 
+    def flomnigui_docs(self, filename: str | None = None):
+        import csaxs_bec
+        from pathlib import Path
+
+        print("The general flOMNI documentation is at \nhttps://sls-csaxs.readthedocs.io/en/latest/user/ptychography/flomni.html#user-ptychography-flomni")
+
+        csaxs_bec_basepath = Path(csaxs_bec.__file__).parent
+        docs_folder = (
+            csaxs_bec_basepath /
+            "bec_ipython_client" / "plugins" / "flomni" / "docs"
+        )
+
+        if not docs_folder.is_dir():
+            raise NotADirectoryError(f"Docs folder not found: {docs_folder}")
+
+        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")
+
+        # --- 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:
             device
@@ -156,8 +208,8 @@ class flomniGuiTools:
             )
             self.progressbar.set_value([progress, subtomo_progress, 0])
             if self.text_box is not None:
-            text = f"Progress report:\n Tomo type: ....................... {self.progress['tomo_type']}\n Projection: ...................... {self.progress['projection']:.0f}\n Total projections expected ....... {self.progress['total_projections']}\n Angle: ........................... {self.progress['angle']}\n Current subtomo: ................. {self.progress['subtomo']}\n Current projection within subtomo: {self.progress['subtomo_projection']}\n Total projections per subtomo: ... {self.progress['subtomo_total_projections']}"
-            self.text_box.set_plain_text(text)
+                text = f"Progress report:\n Tomo type: ....................... {self.progress['tomo_type']}\n Projection: ...................... {self.progress['projection']:.0f}\n Total projections expected ....... {self.progress['total_projections']}\n Angle: ........................... {self.progress['angle']}\n Current subtomo: ................. {self.progress['subtomo']}\n Current projection within subtomo: {self.progress['subtomo_projection']}\n Total projections per subtomo: ... {self.progress['subtomo_total_projections']}"
+                self.text_box.set_plain_text(text)
 
 
 if __name__ == "__main__":

csaxs_bec/bec_ipython_client/plugins/tool_box/debug_tools.py

@@ -0,0 +1,250 @@
+"""Module providing debugging tools for the BEC IPython client at cSAXS."""
+
+from __future__ import annotations
+
+import inspect
+import json
+import os
+import re
+import socket
+from concurrent.futures import ThreadPoolExecutor
+from functools import partial
+from typing import TYPE_CHECKING, Literal
+
+import numpy as np
+from pydantic import BaseModel
+from rich.console import Console
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+from slugify import slugify
+
+if TYPE_CHECKING:
+    from bec_ipython_client.main import BECIPythonClient
+    from bec_lib.devicemanager import DeviceManagerBase
+    from bec_lib.scans import Scans
+    from bec_widgets.cli.client_utils import BECGuiClient
+
+    scans: Scans  # type: ignore[no-redef]
+
+    bec: BECIPythonClient  # type: ignore[no-redef]
+
+    dev: DeviceManagerBase  # type: ignore[no-redef]
+
+
+class Detector(BaseModel):
+    """Model representing a detector configuration."""
+
+    name: str
+    hostnames: list[str]
+    cfg: dict
+
+
+def to_identifier(text: str) -> str:
+    """
+    Convert an unsafe string into a valid Python identifier.
+    """
+    name = slugify(text.strip(), separator="_")
+    name = re.sub(r"[^a-zA-Z0-9_]", "", name)
+
+    if not name:
+        raise ValueError(f"Cannot convert '{text}' to a valid identifier.")
+
+    if name[0].isdigit():
+        name = f"_{name}"
+
+    return name
+
+
+class DebugTools:
+    """A collection of debugging tools for the BEC IPython client at cSAXS."""
+
+    _PURPOSE = (
+        "Debugging helpers for the cSAXS BEC IPython client. These tools are intended for advanced users "
+        "and developers to diagnose and troubleshoot issues within the BEC environment. "
+        "Below are the available methods together with a brief description of their functionality."
+    )
+
+    ######################
+    ## Internal Methods ##
+    ######################
+
+    def _describe(self) -> None:
+        """Pretty-print a description of this debugging tool."""
+        console = Console()
+
+        # Offset for IPython prompt misplacement
+        console.print("\n\n", end="")
+
+        header = Text("DebugTools", style="bold cyan")
+        purpose = Text(self._PURPOSE, style="dim")
+
+        console.print(Panel(purpose, title=header, expand=False))
+
+        table = Table(show_header=True, header_style="bold magenta")
+        table.add_column("Method", style="bold", no_wrap=True)
+        table.add_column("Description")
+
+        for name, member in inspect.getmembers(self, predicate=inspect.ismethod):
+            if name.startswith("_"):
+                continue
+
+            doc = inspect.getdoc(member)
+            short_doc = doc.splitlines()[0] if doc else ""
+            table.add_row(name, short_doc)
+
+        console.print(table)
+
+    def _repr_pretty_(self, p, cycle: bool) -> None:
+        if cycle:
+            p.text("DebugTools(...)")
+        else:
+            self._describe()
+
+    #####################
+    ### MCS Card Check ###
+    #####################
+
+    def _check_if_device_is_loaded(self, device_name: str):
+        """Check if a device is loaded in the current BEC session."""
+        if device_name not in dev:
+            raise RuntimeError(
+                f"Device {device_name} was not loaded in the current active BEC session."
+            )
+
+    def mcs_test_acquire(
+        self, mode: Literal["high_frame", "medium_frame", "low_frame"] = "high_frame"
+    ):
+        """
+        Method to perform a test acquisition with randomized exposure time, burst frames, and cycles
+        on the MCS card using the DDG trigger setup.
+
+        Args:
+            mode (Literal["high_frame", "medium_frame", "low_frame"]): The mode of the test.
+                - 'high_frame': Tests high frame rates with short exposure times.
+                - 'medium_frame': Tests medium frame rates with moderate exposure times.
+                - 'low_frame': Tests low frame rates with longer exposure times.
+        """
+        self._check_if_device_is_loaded("mcs")
+        self._check_if_device_is_loaded("ddg1")
+        self._check_if_device_is_loaded("ddg2")
+
+        if mode == "high_frame":
+            burst_frames = np.random.randint(10_000, 100_000)  # between 10000 and 100000
+            cycles = np.random.randint(5, 20)  # between 5 and 20
+            exp_time = (
+                np.random.rand() * (0.001 - 0.201e-3) + 0.201e-3
+            )  # between 0.000201 ms and 0.001 s
+        elif mode == "medium_frame":
+            burst_frames = np.random.randint(50, 500)  # between 50 and 500
+            cycles = np.random.randint(1, 10)  # between 1 and 10
+            exp_time = np.random.rand() * (0.01 - 0.001) + 0.001  # between 0.001 ms and 0.01 s
+        elif mode == "low_frame":
+            burst_frames = np.random.randint(5, 20)  # between 5 and 20
+            cycles = np.random.randint(1, 5)  # between 1 and 5
+            exp_time = np.random.rand() * (2 - 0.1) + 0.1  # between 0.1 ms and 2 s
+        else:
+            raise ValueError(f"Invalid mode '{mode}' specified for acquire scan test.")
+        print(
+            f"Starting acquire measurement with exp_time={exp_time:.6f}, burst_frames={burst_frames}, cycles={cycles}"
+        )
+        s = scans.acquire(
+            exp_time=exp_time, frames_per_trigger=burst_frames, burst_at_each_point=cycles
+        )
+        s.wait(file_written=True)
+        print("Acquire measurement finished.")
+        print("Checking MCS data...")
+        scan_data = bec.history.get_by_scan_id(s.scan.scan_id)
+        mcs_data = scan_data.devices.mcs
+        print(mcs_data)
+
+        shape = mcs_data._info["mcs_mca_mca1"]["value"]["shape"]
+        expected_shape = (cycles * burst_frames,)
+        # Assert will raise an error if the shapes do not match
+        assert (
+            shape == expected_shape
+        ), f"MCS data shape {shape} does not match expected shape {expected_shape}."
+
+    ########################
+    ### JFJ/Eiger Checks ###
+    ########################
+
+    def _get_jfj_eiger_config(self) -> dict[str, Detector]:
+        """Retrieve the current JFJ/Eiger detector configuration from the BEC client."""
+        # FIXME: Implement REST API call once ready for use from Leo Sala's team.
+        ret = {}
+        base_path = os.path.dirname(__file__)
+        config_path = os.path.join(base_path, "jfj_config.json")
+        with open(config_path, "r", encoding="utf-8") as fh:
+            cfg = json.load(fh)
+
+            for entry in cfg["detector"]:
+                det = Detector(
+                    name=to_identifier(entry["description"]), hostnames=entry["hostname"], cfg=cfg
+                )
+                ret[det.name] = det
+        return ret
+
+    def list_detectors(self) -> list[str]:
+        """
+        List the names of all JFJ/Eiger detectors configured in the BEC client.
+
+        Returns:
+            list[str]: A list of detector names.
+        """
+        detectors = self._get_jfj_eiger_config()
+        return list(detectors.keys())
+
+    def ping_detector(self, detector_name: str) -> bool:
+        """
+        Ping a JFJ/Eiger detector to check if it is reachable.
+
+        Args:
+            detector_name (str): The name of the detector to ping.
+
+        Returns:
+            bool: True if the detector is reachable, False otherwise.
+        """
+        detectors = self._get_jfj_eiger_config()
+        if detector_name not in detectors:
+            raise ValueError(f"Detector '{detector_name}' not found in configuration.")
+
+        det = detectors[detector_name]
+        results = self._ping_many(det.hostnames)
+
+        table = Table(title=f"Ping results for detector '{detector_name}'")
+        table.add_column("Hostname", style="cyan", no_wrap=True)
+        table.add_column("Status", style="magenta")
+
+        for host, alive in results.items():
+            status = "[green]OK[/green]" if alive else "[red]DOWN[/red]"
+            table.add_row(host, status)
+
+        console = Console()
+        console.print(table)
+
+    def _ping_many(self, hosts: list[str], port=22, timeout=2, max_workers=None):
+        max_workers = max_workers or len(hosts)
+        with ThreadPoolExecutor(max_workers=max_workers) as executor:
+            primed_ping = partial(self._ping, port=port, timeout=timeout)
+            pings = executor.map(primed_ping, hosts)
+            return dict(zip(hosts, pings))
+
+    def _ping(self, host: str, port=23, timeout=2):  # telnet is port 23
+        address = (host, port)
+        try:
+            with socket.create_connection(address, timeout):
+                return True
+        except OSError:
+            return False
+
+    def open_it_service_page(self):
+        """Open the overview of IT services hosted by Science IT Infrastructure and Services for cSAXS."""
+        gui: BECGuiClient = bec.gui
+        dock_area = gui.new()
+        print("Opening IT service page in new dock...")
+        url = "https://metrics.psi.ch/d/saf8mxv/x12sa?orgId=1&from=now-24h&to=now&timezone=browser&var-receiver_hosts=sls-jfjoch-001.psi.ch&var-writer_hosts=xbl-daq-34.psi.ch&var-beamline=X12SA&var-slurm_partitions=csaxs&var-receiver_services=broker&var-writer_services=writer&refresh=15m"
+        # FIXME BEC WIDGETS v3
+        dock = dock_area.new()
+        wb = dock.new(widget=gui.available_widgets.WebsiteWidget)
+        wb.set_url(url)

csaxs_bec/bec_ipython_client/plugins/tool_box/jfj_config.json

@@ -0,0 +1,162 @@
+{
+  "zeromq" : {
+    "image_socket": ["tcp://0.0.0.0:5500"]
+  },
+  "zeromq_preview": {
+    "socket_address": "tcp://0.0.0.0:5400",
+    "enabled": true,
+    "period_ms": 1000
+  },
+  "zeromq_metadata" : {
+   "socket_address": "tcp://0.0.0.0:5600",
+   "enabled": true,
+   "period_ms": 100
+  },
+  "instrument" : {
+    "source_name": "Swiss Light Source",
+    "instrument_name": "cSAXS",
+    "source_type": "Synchrotron X-ray Source"
+  },
+  "detector": [
+    {
+      "description": "EIGER 9M",
+      "serial_number": "E1",
+      "type": "EIGER",
+      "mirror_y": true,
+      "base_data_ipv4_address": "10.10.10.10",
+      "calibration_file":["/opt/jfjoch/calibration/"],
+      "standard_geometry" : {
+        "nmodules": 18,
+        "modules_in_row": 3,
+        "gap_x": 8,
+        "gap_y": 36
+      },
+      "hostname": [
+        "beb101",
+        "beb103",
+        "beb014",
+        "beb078",
+        "beb060",
+        "beb030",
+        "beb092",
+        "beb178",
+        "beb009",
+        "beb038",
+        "beb056",
+        "beb058",
+        "beb033",
+        "beb113",
+        "beb005",
+        "beb017",
+        "beb119",
+        "beb095",
+        "beb186",
+        "beb042",
+        "beb106",
+        "beb059",
+        "beb111",
+        "beb203",
+        "beb100",
+        "beb093",
+        "beb123",
+        "beb061",
+        "beb121",
+        "beb055",
+        "beb004",
+        "beb190",
+        "beb054",
+        "beb189",
+        "beb107",
+        "beb115"
+      ]
+    },
+    {
+      "description": "EIGER 8.5M (tmp)",
+      "serial_number": "E1-tmp",
+      "type": "EIGER",
+      "mirror_y": true,
+      "base_data_ipv4_address": "10.10.10.10",
+      "calibration_file":["/opt/jfjoch/calibration/"],
+      "standard_geometry" : {
+        "nmodules": 17,
+        "modules_in_row": 3,
+        "gap_x": 8,
+        "gap_y": 36
+      },
+      "hostname": [
+        "beb101",
+        "beb103",
+        "beb014",
+        "beb078",
+        "beb060",
+        "beb030",
+        "beb092",
+        "beb178",
+        "beb009",
+        "beb038",
+        "beb056",
+        "beb058",
+        "beb033",
+        "beb113",
+        "beb005",
+        "beb017",
+        "beb119",
+        "beb095",
+        "beb186",
+        "beb042",
+        "beb106",
+        "beb059",
+        "beb100",
+        "beb093",
+        "beb123",
+        "beb061",
+        "beb121",
+        "beb055",
+        "beb004",
+        "beb190",
+        "beb054",
+        "beb189",
+        "beb107",
+        "beb115"
+      ]
+    },
+    {
+      "description": "EIGER 1.5M",
+      "serial_number": "E2",
+      "type": "EIGER",
+      "mirror_y": true,
+      "base_data_ipv4_address": "10.10.11.10",
+      "calibration_file":["/opt/jfjoch/calibration_e1p5m/"],
+      "standard_geometry" : {
+        "nmodules": 3,
+        "modules_in_row": 1,
+        "gap_x": 8,
+        "gap_y": 36
+      },
+      "hostname": ["beb062", "beb026", "beb099", "beb084", "beb120", "beb108"]
+    }
+  ],
+  "frontend_directory": "/usr/share/jfjoch/frontend/",
+  "image_pusher": "ZeroMQ",
+  "numa_policy": "n2g2",
+  "receiver_threads": 64,
+  "image_buffer_MiB": 96000,
+  "pcie": [
+    {
+    "blk": "/dev/jfjoch0",
+    "ipv4": "10.10.10.1"
+    },
+    {
+      "blk": "/dev/jfjoch1",
+      "ipv4": "10.10.10.2"
+    },
+    {
+      "blk": "/dev/jfjoch2",
+      "ipv4": "10.10.10.3"
+    },
+    {
+      "blk": "/dev/jfjoch3",
+      "ipv4": "10.10.10.4"
+    }
+  ]
+}

csaxs_bec/bec_ipython_client/startup/post_startup.py

@@ -48,6 +48,11 @@ elif _args.session.lower() == "csaxs":
 
     logger.success("cSAXS session loaded.")
 
+from csaxs_bec.bec_ipython_client.plugins.tool_box.debug_tools import DebugTools
+
+debug = DebugTools()
+logger.success("Debug tools loaded. Use 'debug' to access them.")
+
 
 # SETUP BEAMLINE INFO
 from bec_ipython_client.plugins.SLS.sls_info import OperatorInfo, SLSInfo

csaxs_bec/devices/epics/delay_generator_csaxs/README.md

@@ -0,0 +1,58 @@
+# Delay Generator implementation at the CSAXS beamline
+
+This module provides an ophyd device implementation for the Stanford Research Systems Delay Generator DDG645, used at the cSAXS beamline as a master timing source for detector triggering and other beamline devices. Detailed information about the DDG manual can be found here:
+https://www.thinksrs.com/downloads/pdfs/manuals/DG645m.pdf. 
+The implementation is based on a community EPICS driver (https://github.com/epics-modules/delaygen?tab=readme-ov-file).
+
+**EPICS Interface** 
+
+At the cSAXS beamline, the DDG panel is avaiable via caqtdm on the beamline consoles.
+
+``` bash
+caqtdm -noMsg -attach -macro P=X12SA-CPCL-DDG,R=1: srsDG645.ui
+```
+with R=1,2,3,4,5 for 5 different DDG units installed at CSAXS.
+
+# Ophyd Device integration at cSAXS
+For cSAXS, a custom ophyd device class implementation of the DDG is provided [here](./delay_generator_csaxs.py). This class provides a basic interface to the DDG PVs. The interface provides channels 'A', B', 'C', ... with setpoint, readback and references, as well as high level parameters such as *width* and *delay*. Please check the source code of the class for more details of the implementation.
+
+In addition, the class provides a set of utility methods to configure sets of channel pairs 'AB', 'CD', ... as commonly needed in operation at the beamline. At the cSAXS beamline, a single DDG device is used as a master timing source for other devices. The general scheme is described in a [PDF document here](./trigger_scheme_ddg1_ddg2.pdf). Below is a description of the configuration of the two DDG units used at cSAXS for detector triggering and beamline shutter control.
+
+## Master card: DDG1 (X12SA-CPCL-DDG1) 
+The master [delay generator DDG1](./ddg_1.py) is configured to provide the following signals:
+
+**Connection Scheme**:
+- EXT/EN: May be connected to external devices, e.g. SGalil motion controller for fly scans.
+- Operation Mode: Burst mode, but with single burst (burst count = 1). This is for practical reasons as it allows
+to interrupt and ongoing sequence if needed.
+- Software Trigger: Controlled through BEC.
+- State Control: BEC checks the *state* of this DDG to wait for the completion of a timing sequence.
+
+**Delay Pairs**:
+- DelayPair 'AB': Provides the external enable (EXT/EN) signal to the second DDG (R=2).
+- DelayPair 'CD': Controls the beamline shutter.
+- DelayPair 'EF': Generates pulses for the MCS card, combined with the detector pulse train via an OR gate. This ensures the MCS card receives an additional pulse required for proper operation.
+
+**Delay Channels**:
+- a = t0 + 2ms (2ms delay to allow the shutter to open)
+- b = a + 1us (short pulse)
+- c = t0
+- d = a + exp_time * burst_count + 1ms (to allow the shutter to close)
+- e = d
+- f = e + 1us (short pulse to OR gate for MCS triggering)
+
+## Detector card: DDG2 (X12SA-CPCL-DDG2) 
+The second [delay generator DDG2](./ddg_2.py) is configured to provide the following signals:
+
+**Connection Scheme**:
+- EXT/EN: Connected to the DelayPair AB of the master DDG (R=1).
+- Operation Mode: Burst mode: The *burst count* is set to the number of frames per trigger. The *burst delay* is set to 0, and the *burst period* is set to the exposure time.
+- Software Trigger: Irrelevant, as the device is externally triggered by DDG1.
+
+**Delay Pairs**:
+- DelayPair 'AB': Provides the trigger signal to the detector.
+
+**Delay Channels**:
+- a = t0
+- b = a + (exp_time - READOUT_TIMES)
+

csaxs_bec/devices/epics/delay_generator_csaxs/ddg_1.py

@@ -52,7 +52,7 @@ from csaxs_bec.devices.epics.delay_generator_csaxs.delay_generator_csaxs import
     LiteralChannels,
     StatusBitsCompareStatus,
 )
-from csaxs_bec.devices.epics.mcs_card.mcs_card_csaxs import ACQUIRING, READYTOREAD
+from csaxs_bec.devices.epics.mcs_card.mcs_card_csaxs import ACQUIRING
 
 if TYPE_CHECKING:  # pragma: no cover
     from bec_lib.devicemanager import DeviceManagerBase, ScanInfo
@@ -61,6 +61,13 @@ if TYPE_CHECKING:  # pragma: no cover
 
 logger = bec_logger.logger
 
+########################
+## DEFAULT SETTINGS ####
+########################
+
+# NOTE Default channel configuration for all channels of the DDG1 delay generator
+# This can be adapted as needed, or fine-tuned per channel. On every reload of the
+# device configuration in BEC, these values will be set into the DDG1 device.
 _DEFAULT_CHANNEL_CONFIG: ChannelConfig = {
     "amplitude": 5.0,
     "offset": 0.0,
@@ -68,6 +75,8 @@ _DEFAULT_CHANNEL_CONFIG: ChannelConfig = {
     "mode": "ttl",
 }
 
+# NOTE Here you can adapt the default IO configuration for all channels of the DDG1
+# Currently, all channels are set to the same default configuration `_DEFAULT_CHANNEL_CONFIG`.
 DEFAULT_IO_CONFIG: dict[AllChannelNames, ChannelConfig] = {
     "t0": _DEFAULT_CHANNEL_CONFIG,
     "ab": _DEFAULT_CHANNEL_CONFIG,
@@ -75,9 +84,19 @@ DEFAULT_IO_CONFIG: dict[AllChannelNames, ChannelConfig] = {
     "ef": _DEFAULT_CHANNEL_CONFIG,
     "gh": _DEFAULT_CHANNEL_CONFIG,
 }
+
 DEFAULT_TRIGGER_SOURCE: TRIGGERSOURCE = TRIGGERSOURCE.SINGLE_SHOT
+
+# NOTE Default readout times for each channel, can be adapted as needed.
+# These values are relevant to calculate proper widths of the timing signals.
+# They also define a minimum exposure time that can be used as they are subtracted
+# as dead times from the exposure time.
 DEFAULT_READOUT_TIMES = {"ab": 2e-4, "cd": 2e-4, "ef": 2e-4, "gh": 2e-4}  # 0.2 ms 5kHz
 
+# NOTE Default channel references for each channel of the DDG1 delay generator.
+# This needs to be carefully adjusted to match the envisioned trigger scheme.
+# If the trigger scheme changes, adapt the values here together with the README and
+# PDF `trigger_scheme_ddg1_ddg2.pdf`.
 DEFAULT_REFERENCES: list[tuple[LiteralChannels, CHANNELREFERENCE]] = [
     ("A", CHANNELREFERENCE.T0),  # T0 + 2ms delay
     ("B", CHANNELREFERENCE.A),
@@ -89,14 +108,27 @@ DEFAULT_REFERENCES: list[tuple[LiteralChannels, CHANNELREFERENCE]] = [
     ("H", CHANNELREFERENCE.G),
 ]
 
+###############################
+## DDG1 IMPLEMENTATION ########
+###############################
+
 
 class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
     """
-    Implementation of DelayGeneratorCSAXS for master trigger delay generator at X12SA-CPCL-DDG1.
-    It will be triggered by a soft trigger from BEC or a hardware trigger from a beamline device
-    (e.g. the Galil stages). It is operated in standard mode, not burst mode and will trigger the
-    EXT/EN of DDG2 (channel ab). It is responsible for opening the shutter (channel cd) and sending
-    an extra trigger to an or gate for the MCS card (channel ef).
+
+    Implementation of the DelayGenerator DDG1 for the cSAXS beamline. It is the main trigger
+    source for the cSAXS beamline, and will be triggered by BEC through a software trigger or
+    by a hardware trigger from a beamline device (e.g. Galil stages). Specific implementation
+    of the cabling logic expected for this device are described in the module README, the attached
+    PDF 'trigger_scheme_ddg1_ddg2.pdf' and the module docstring.
+
+    The IOC prefix is 'X12SA-CPCL-DDG1:'.
+
+    Args:
+        name (str): Name of the device.
+        prefix (str, optional): EPICS prefix for the device. Defaults to ''.
+        scan_info (ScanInfo | None, optional): Scan info object. Defaults to None.
+        device_manager (DeviceManagerBase | None, optional): Device manager. Defaults to None.
     """
 
     def __init__(
@@ -107,9 +139,6 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
         device_manager: DeviceManagerBase | None = None,
         **kwargs,
     ):
-        """
-        Initialize the MCSCardCSAXS with the given arguments and keyword arguments.
-        """
         super().__init__(
             name=name, prefix=prefix, scan_info=scan_info, device_manager=device_manager, **kwargs
         )
@@ -123,70 +152,172 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
     # pylint: disable=attribute-defined-outside-init
     def on_connected(self) -> None:
         """
-        Set the default values on the device - intended to overwrite everything to a usable default state.
-        Sets DEFAULT_IO_CONFIG into each channel, sets the trigger source to DEFAULT_TRIGGER_SOURCE,
-        and turns off burst mode.
+
+        This method is called after the device is initialized and all signals are connected. This happens
+        when a device configuration is loaded in BEC.
+
+        It sets the default values for this device - intended to overwrite everything to a usable default state.
+        For this purpose, we use the DEFAULT SETTINGS defined at the top of this module.
+
+        To ensure that this process is robust, we follow these steps:
+        - First, we stop any ongoing burst mode operation.
+        - Then, we set the DEFAULT_IO_CONFIG for each channel, the trigger source to DEFAULT_TRIGGER_SOURCE,
+          and the channel references to DEFAULT_REFERENCES.
+        - We set the state proc_status to be event based. This triggers readouts of the EventStatusLI bit
+          based on events. This was empirically found to be a stable solution in combination with the poll
+          loop of the state.
+        - Finally, we set the burst delay to 0, to set it to be of no delay.
         """
-        self.burst_disable()  # it is possible to miss setting settings if burst is enabled
+
+        # NOTE First we make sure that there is nothing running on the DDG. This seems to
+        # help to tackle that the DDG occasionally freezes during the first scan
+        # after reconnecting to it. Do not remove.
+        self.stop_ddg()
+
+        # NOTE Setting DEFAULT configurations for IO config, trigger config and references.
+        # The three dictionaries above 'DEFAULT_IO_CONFIG', 'DEFAULT_TRIGGER_SOURCE' and
+        # 'DEFAULT_REFERNCES' should be used to adapt configurations if needed.
         for channel, config in DEFAULT_IO_CONFIG.items():
             self.set_io_values(channel, **config)
         self.set_trigger(DEFAULT_TRIGGER_SOURCE)
         self.set_references_for_channels(DEFAULT_REFERENCES)
-        # Set proc status to passively update with 5Hz (0.2s)
+
+        # NOTE Set state proc_status to be event based. This triggers readouts of the EventStatusLI bit
+        # based on events. This was empirically found to be a stable solution in combination with the poll
+        # loop of the state.
         self.state.proc_status_mode.put(PROC_EVENT_MODE.EVENT)
 
+        # NOTE Burst delay should be set to 0, don't remove as this will not be checked
+        # Also set the burst count to 1 to only have a single pulse for DDG1.
+        self.burst_delay.put(0)
+        self.burst_count.put(1)
+
     def on_stage(self) -> None:
         """
-        Stage logic for the DDG1 device, being th main trigger delay generator for CSAXS.
-        For standard scans, it will be triggered by a soft trigger from BEC.
-        It also has a hardware trigger feeded into the EXT/EN for fly-scanning, i.e. Galil stages.
 
-        This DDG is always not in burst mode.
+        This method is called in preparation for a scan. All information about the upcoming
+        scan is available in self.scan_info.msg at this point. We use this information to
+        configure the DDG1 for the upcoming scan.
+
+        The DDG is operated in burst mode for the scan, but with only a single burst pulse.
+        THe length of the pulse is set to the expected exposure time for a single trigger,
+        which includes any burst acquisitions if frames_per_trigger > 1.
+
+        The logic is as follows:
+        - We check if any default burst parameters need to be set, and set them if needed.
+        - We calculate the burst pulse width based on the exposure time and frames_per_trigger.
+        - We set the burst_period and the shutter signal (delay pairs cd) to be
+            exposure_time * frames_per_trigger + 3ms (2ms for shutter to open, 1ms to close).
+        - We set the delay pairs ab to be 2ms delayed (to allow the shutter to open) with a width of 1us to trigger DDG2.
+        - We set the delay pairs ef to be triggered after the shutter closes with a width of 1us to trigger the MCS card.
+        - Finally, we add a short sleep to ensure that the IOC and DDG HW process the values properly.
         """
-        exp_time = self.scan_info.msg.scan_parameters["exp_time"]
-        self.burst_enable(1, 0, exp_time)
-        exp_time = self.scan_info.msg.scan_parameters["exp_time"]
+        start_time = time.time()
+
+        ########################################
+        ### Burst mode settings ################
+        ########################################
+
+        # NOTE We check here if the delay generator is not in burst mode. We check these values
+        # and set them to the requried values if they differ from the expected ones.
+        # This has been found empirically to improve stability and avoid HW getting stuck in triggering cycles.
+        if self.burst_mode.get() == 0:
+            self.burst_mode.put(1)
+
+        if self.burst_delay.get() != 0:
+            self.burst_delay.put(0)
+
+        if self.burst_count.get() != 1:
+            self.burst_count.put(1)
+
+        #########################################
+        ### Setup timing for burst and delays ###
+        #########################################
+
         frames_per_trigger = self.scan_info.msg.scan_parameters["frames_per_trigger"]
+        exp_time = self.scan_info.msg.scan_parameters["exp_time"]
+
+        # Burst Period DDG1
+        # Set burst_period to shutter width
+        # c/t0 + 2ms + exp_time * burst_count + 1ms
+        shutter_width = 2e-3 + exp_time * frames_per_trigger + 1e-3
+        if self.burst_period.get() != shutter_width:
+            self.burst_period.put(shutter_width)
+
         # Trigger DDG2
         # a = t0 + 2ms, b = a + 1us
         # a has reference to t0, b has reference to a
+        # Add delay of 2ms to allow shutter to open
         self.set_delay_pairs(channel="ab", delay=2e-3, width=1e-6)
+
         # Trigger shutter
-        shutter_width = 2e-3 + exp_time * frames_per_trigger + 1e-3
         # d = c/t0 + 2ms + exp_time * burst_count + 1ms
         # c has reference to t0, d has reference to c
+        # Shutter opens without delay at t0, closes after exp_time * burst_count + 3ms (2ms open, 1ms close)
         self.set_delay_pairs(channel="cd", delay=0, width=shutter_width)
+
         # Trigger extra pulse for MCS OR gate
         # f = e + 1us
         # e has refernce to d, f has reference to e
         self.set_delay_pairs(channel="ef", delay=0, width=1e-6)
-        time.sleep(
-            0.2
-        )  # After staging, make sure that the DDG HW has some time to process changes properly.
+
+        # NOTE Add additional sleep to make sure that the IOC and DDG HW process the values properly
+        # This value has been choosen empirically after testing with the HW. It's
+        # also just called once per scan and has been found to improve stability of the HW.
+        time.sleep(0.2)
+        logger.info(f"DDG {self.name} on_stage completed in {time.time() - start_time:.3f}s.")
 
     def _prepare_mcs_on_trigger(self, mcs: MCSCardCSAXS) -> None:
-        """Prepare the MCS card for the next trigger.
-        This method holds the logic to ensure that the MCS card is ready to read.
-        It's logic is coupled to the MCS card implementation and the DDG1 trigger logic.
         """
-        status_ready_read = CompareStatus(mcs.ready_to_read, READYTOREAD.DONE)
-        mcs.stop_all.put(1)
-        status_acquiring = TransitionStatus(mcs.acquiring, [ACQUIRING.DONE, ACQUIRING.ACQUIRING])
-        self.cancel_on_stop(status_ready_read)
-        self.cancel_on_stop(status_acquiring)
-        status_ready_read.wait(10)
 
-        mcs.ready_to_read.put(READYTOREAD.PROCESSING)
+        This method is used by the DDG1 on_trigger method to prepare the MCS card for the next trigger.
+        It checks that the MCS card is properly prepared before BEC sends a software trigger to the DDG1,
+        which is needed for step scans.
+
+        It relies on the MCS card implementation and needs to be adapted if the MCS card logic changes.
+        """
+
+        # NOTE First we wait that the MCS card is not acquiring. We add here a timeout of 5s to avoid
+        # a deadlock in case the MCS card is stuck for some reason. This should not happen normally.
+        status = CompareStatus(mcs.acquiring, ACQUIRING.DONE)
+        self.cancel_on_stop(status)
+        status.wait(timeout=5)
+
+        # NOTE Clear the '_omit_mca_callbacks' flag. This makes sure that data received from the mca1...mca3
+        # counters are forwarded to BEC. Once the flag is set, we create a TransitionStatus DONE->ACQUIRING
+        # and start the acquisition through erase_start.put(1). Finally, we wait for the card to go to ACQUIRING state.
+        mcs._omit_mca_callbacks.clear()  # pylint: disable=protected-access
+        status_acquiring = TransitionStatus(mcs.acquiring, [ACQUIRING.DONE, ACQUIRING.ACQUIRING])
+        self.cancel_on_stop(status_acquiring)
         mcs.erase_start.put(1)
-        status_acquiring.wait(timeout=10)  # Allow 10 seconds in case communication is slow
+
+        return status_acquiring
 
     def _poll_event_status(self) -> None:
         """
-        Poll the event status register in a background thread. Control
-        the polling with the _poll_thread_run_event and _poll_thread_kill_event.
+
+        Polling loop to retrieve the event status register of the delay generator DDG1.
+        This method runs in a background thread and the polling is controlled through the
+        '_poll_thread_run_event' and '_poll_thread_kill_event'. Polling should only become
+        active when a software trigger was sent in BEC and we are waiting for the burst to complete.
         """
+        # Main loop of the polling thread. As long as the kill event is not set, the loop continues.
         while not self._poll_thread_kill_event.is_set():
+
+            # NOTE Main wait event for the polling thread. If the _poll_thread_run_event is not set,
+            # The thread will wait here. This event is used to start/stop polling from outside the thread,
+            # as used in on_trigger and on_stop. Please make sure to set this event also when the thread
+            # should be killed as its otherwise stuck inside the wait.
             self._poll_thread_run_event.wait()
+
+            # NOTE Set the event to indicate that we are currently still in the poll_loop. This is needed
+            # as we have to use sleeps of 20ms within the poll loop. These sleeps were empirically detetermined
+            # to ensure that no state changes are missed. However, these sleeps have the side effect that
+            # setting the '_poll_thread_run_event' may not immediately stop the polling. Therefore, we need the
+            # '_poll_thread_poll_loop_done' event to indicate that polling has finished. If this logic is changed,
+            # it requires careful testing as failure rates can be in the 1 out of 500 events rate, which are still
+            # not acceptable for operation. The current implementation has been tested with failure rates smaller then
+            # ~ 1:100000 if failures happened at all.
             self._poll_thread_poll_loop_done.clear()
             while (
                 self._poll_thread_run_event.is_set() and not self._poll_thread_kill_event.is_set()
@@ -198,29 +329,49 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
                     logger.error(
                         f"Exception in polling loop thread, polling continues...\n Error content:\n{content}"
                     )
-
+            # NOTE Set the _poll_thread_poll_loop_done event to indicate that we are done polling. Do not remove!
             self._poll_thread_poll_loop_done.set()
 
     def _poll_loop(self) -> None:
         """
-        Poll loop to update event status.
-        The checks ensure that the loop exist after each operation and be stuck in sleep.
-        The 20ms sleep was added to ensure that the event status is not polled too frequently,
-        and to give the device time to process the previous command. This was found empirically
-        to be necessary to avoid missing events.
-        IMPORTANT: Do not remove sleeps or try to optimize this logic. This seems to be a
-        fragile balance between polling frequency and device processing time. Also in between
-        start/stop of polling. Please also consider that there is a sleep in on_trigger and
-        that this might also be necessary to avoid that HW becomes unavailable/unstable.
+
+        This method is the actual poll loop to update the event status from the satus register
+        of the delay generator DDG1.
+
+        It follows a procedure that was established empirically after extended testing with the HW.
+        Any adaptations to this logic need to be carefully tested to avoid that the HW becomes unstable.
+        NOTE: Sleeps are important in this logic, and should not be removed or optimized without extensive testing.
+        20ms has been found to be the minimum sleep time that proofed to be stable in operation.
+
+        The logic is as follows:
+        - Set the 'proc_status' to 1 with use_complete=True to trigger an event based readout of the EventStatusLI.
+        - Sleep 20ms to give the device time to process the command.
+        - Check if the kill event or run event are cleared, and exit the loop if so.
+        - Read the EventStatusLI channel to update the event status.
+        - Check again if the kill event or run event are cleared, and exit the loop if so.
+
+        Please note that any important changes of the status register reading will trigger callbacks
+        if attached to the event status signal. These callbacks hold the logic to resolve status objects
+        when waiting for specific events (e.g. end of burst).
+
+
         """
         self.state.proc_status.put(1, use_complete=True)
-        time.sleep(0.02)  # 20ms delay for processing, important for not missing events
+
+        # NOTE: Important sleep that has been empirically determined after testing for a long time
+        # Only remove if absolutely certain that the DDG logic of polling the EventStatusLI works without it.
+        time.sleep(0.02)
+
         if self._poll_thread_kill_event.is_set() or not self._poll_thread_run_event.is_set():
             return
+
         self.state.event_status.get(use_monitor=False)
         if self._poll_thread_kill_event.is_set() or not self._poll_thread_run_event.is_set():
             return
-        time.sleep(0.02)  # 20ms delay for processing, important for not missing events
+
+        # NOTE: Again important sleep that has been empirically determined after testing for a long time
+        # Only remove if certain that logic can be replaced to not risk HW failures.
+        time.sleep(0.02)
 
     def _start_polling(self) -> None:
         """Start the polling loop in the background thread."""
@@ -240,8 +391,23 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
         else:
             logger.info("Polling thread stopped.")
 
-    def _prepare_trigger_status_event(self, timeout: float | None = None) -> DeviceStatus:
-        """Prepare the trigger status event for the DDG1, and trigger the de"""
+    def _prepare_trigger_status_event(
+        self, timeout: float | None = None
+    ) -> StatusBitsCompareStatus:
+        """
+        Method to prepare a status object that indicates the end of a burst cycle.
+        It also sets up a callback to cancel the polling of the event status register
+        if the status is cancelled externally (e.g. by stopping the device). In addition,
+        a timeout can either be specified, or is automatically calculated based on the
+        exposure time, frames_per_trigger and a default extra time of 5 seconds.
+
+        Args:
+            timeout (float | None, optional): Timeout for the status object. If None, a
+                default timeout based on exposure time and frames_per_trigger is used.
+
+        Returns:
+            StatusBitsCompareStatus:
+        """
         if timeout is None:
             # Default timeout of 5 seconds + exposure time * frames_per_trigger
             timeout = 5 + self.scan_info.msg.scan_parameters.get(
@@ -251,7 +417,9 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
         # Callback to cancel the status if the device is stopped
         def cancel_cb(status: CompareStatus) -> None:
             """Callback to cancel the status if the device is stopped."""
-            self._stop_polling()
+            logger.debug("DDG1 end of burst detected, stopping polling loop.")
+            if status.done:
+                self._stop_polling()
 
         # Run false is important to ensure that the status is only checked on the next event status update
         status = StatusBitsCompareStatus(
@@ -262,38 +430,63 @@ class DDG1(PSIDeviceBase, DelayGeneratorCSAXS):
         return status
 
     def on_trigger(self) -> DeviceStatus:
-        """Note, we need to add a delay to the StatusBits callback on the event_status.
-        If we don't then subsequent triggers may reach the DDG too early, and will be ignored. To
-        avoid this, we've added the option to specify a delay via add_delay, default here is 50ms.
         """
-        # Stop polling, poll once manually to ensure that the register is clean
+        This method is called from BEC as a software trigger.
+
+        It follows a specific procedure to ensure that the DDG1 and MCS card are properly handled
+        on a trigger event. The established logic is as follows:
+
+        - Stop polling the event status register to avoid that the polling loop is still active
+            before sending the software trigger. This needs to be done to avoid conflicts
+            in reading the event status register.
+        - Wait for the _poll_thread_poll_loop_done event to ensure that the polling loop is no
+            longer active. A timeout of 1s is plenty as sleeps of 20ms are used in the poll loop.
+        - Add an extra sleep of 20ms to make sure that the HW is again ready to process new commands.
+            This has been found empirically after long testing to improve stability.
+        - If the MCS card is present in the current session of BEC, prepare the card for the next trigger.
+        - Prepare a status StatusBitsCompareStatus that will be resolved once the burst is done.
+        - Start the polling loop again to monitor the event status register.
+        - Send the software trigger to the DDG1
+        - Return the status object to BEC which will automatically resolve once the status register has
+            the END_OF_BURST bit set. The callback of the status object will also stop the polling loop.
+        """
         self._stop_polling()
         self._poll_thread_poll_loop_done.wait(timeout=1)
-        # IMPORTANT: Keep this sleep setting, as it is necessary to avoid that the HW
-        # becomes unresponsive. This was found empirically and seems to be necessary
+        # NOTE: This sleep is important to ensure that the HW is ready to process new commands.
+        # It has been empirically determined after long testing that this improves stability.
         time.sleep(0.02)
 
+        # NOTE If the MCS card is present in the current session of BEC,
+        # we prepare the card for the next trigger. The procedure is implemented
+        # in the '_prepare_mcs_on_trigger' method.
         # Prepare the MCS card for the next software trigger
         mcs = self.device_manager.devices.get("mcs", None)
-        if mcs is None:
+        if mcs is None or mcs.enabled is False:
             logger.info("Did not find mcs card with name 'mcs' in current session")
         else:
-            self._prepare_mcs_on_trigger(mcs)
-        # Prepare status with callback to cancel the polling once finished
+            status_mcs = self._prepare_mcs_on_trigger(mcs)
+            # NOTE Timeout of 3s should be plenty, any longer wait should checked. If this happens to crash
+            # an acquisition regularly with a WaitTimeoutError, the timeout can be increased but it should
+            # be investigated why the EPICS interface is slow to respond.
+            status_mcs.wait(timeout=3)
+
+        # Prepare StatusBitsCompareStatus to resolve once the END_OF_BURST bit was set.
         status = self._prepare_trigger_status_event()
-        # Start polling
+
+        # Start polling thread again to monitor event status
         self._start_polling()
         # Trigger the DDG1
         self.trigger_shot.put(1, use_complete=True)
         return status
 
     def on_stop(self) -> None:
-        """Stop the delay generator by setting the burst mode to 0"""
+        """Stop the delay generator HW and polling thread when the device is stopped."""
         self.stop_ddg()
         self._stop_polling()
 
     def on_destroy(self) -> None:
         """Clean up resources when the device is destroyed."""
+        self.stop_ddg()
         self._kill_poll_thread()
 
 

csaxs_bec/devices/epics/delay_generator_csaxs/ddg_2.py

@@ -25,7 +25,7 @@ Burst mode is enabled:
 import time
 
 from bec_lib.logger import bec_logger
-from ophyd import DeviceStatus, StatusBase
+from ophyd_devices import DeviceStatus, StatusBase
 from ophyd_devices.interfaces.base_classes.psi_device_base import PSIDeviceBase
 
 from csaxs_bec.devices.epics.delay_generator_csaxs.delay_generator_csaxs import (
@@ -41,6 +41,11 @@ from csaxs_bec.devices.epics.delay_generator_csaxs.delay_generator_csaxs import
 
 logger = bec_logger.logger
 
+########################
+## DEFAULT SETTINGS ####
+########################
+
+# NOTE Default channel configuration for the DDG2 delay generator channels
 _DEFAULT_CHANNEL_CONFIG: ChannelConfig = {
     "amplitude": 5.0,
     "offset": 0.0,
@@ -48,6 +53,9 @@ _DEFAULT_CHANNEL_CONFIG: ChannelConfig = {
     "mode": "ttl",
 }
 
+# NOTE Default IO configuration for all channels in DDG2
+# Each channel uses the same default configuration as defined above
+# If needed, individual channel configurations should be modified here.
 DEFAULT_IO_CONFIG: dict[AllChannelNames, ChannelConfig] = {
     "t0": _DEFAULT_CHANNEL_CONFIG,
     "ab": _DEFAULT_CHANNEL_CONFIG,
@@ -55,9 +63,16 @@ DEFAULT_IO_CONFIG: dict[AllChannelNames, ChannelConfig] = {
     "ef": _DEFAULT_CHANNEL_CONFIG,
     "gh": _DEFAULT_CHANNEL_CONFIG,
 }
+
 DEFAULT_TRIGGER_SOURCE: TRIGGERSOURCE = TRIGGERSOURCE.EXT_RISING_EDGE
+
+# NOTE Default readout times for the detectors connected to DDG2
+# These values are used to calculate the difference between the burst_period and the pulse width of
+# individual channel pairs. They also mark a lower limit for the exposure time. Needs to be
+# adjusted if the exposure time should possibly go below 0.2 ms.
 DEFAULT_READOUT_TIMES = {"ab": 2e-4, "cd": 2e-4, "ef": 2e-4, "gh": 2e-4}  # 0.2 ms 5kHz
 
+# NOTE Default refernce settings for each channel in DDG2
 DEFAULT_REFERENCES: list[tuple[LiteralChannels, CHANNELREFERENCE]] = [
     ("A", CHANNELREFERENCE.T0),
     ("B", CHANNELREFERENCE.A),
@@ -69,9 +84,27 @@ DEFAULT_REFERENCES: list[tuple[LiteralChannels, CHANNELREFERENCE]] = [
     ("H", CHANNELREFERENCE.G),
 ]
 
+###############################
+## DDG2 IMPLEMENTATION ########
+###############################
+
 
 class DDG2(PSIDeviceBase, DelayGeneratorCSAXS):
     """
+
+    Implementation of the DelayGenerator DDG2 for the cSAXS beamline. This delay generator is
+    reponsible to create triggers for the detectors. It is configured in burst mode. Please
+    check the module docstring, the module README and the attached PDF 'trigger_scheme_ddg1_ddg2.pdf'
+    for more information about the expected cabling and trigger logic.
+
+    The IOC prefix is 'X12SA-CPCL-DDG2:'.
+
+    Args:
+        name (str): Name of the device.
+        prefix (str, optional): EPICS prefix for the device. Defaults to ''.
+        scan_info (ScanInfo | None, optional): Scan info object. Defaults to None.
+        device_manager (DeviceManagerBase | None, optional): Device manager. Defaults to None.
+
     Implementation of DelayGeneratorCSAXS for the CSAXS master trigger delay generator at X12SA-CPCL-DDG2.
     This device is responsible for creating triggers in burst mode and is connected to a multiplexer that
     distributes the trigger to the detectors. The DDG2 is triggered by the DDG1 through the EXT/EN channel.
@@ -80,10 +113,22 @@ class DDG2(PSIDeviceBase, DelayGeneratorCSAXS):
     # pylint: disable=attribute-defined-outside-init
     def on_connected(self) -> None:
         """
-        Set the default values on the device - intended to overwrite everything to a usable default state.
-        Sets DEFAULT_IO_CONFIG into each channel, sets the trigger source to DEFAULT_TRIGGER_SOURCE.
+
+        This method is called after the device is initialized and all signals are connected. This happens
+        when a device configuration is loaded in BEC.
+
+        It sets the default values for this device - intended to overwrite everything to a usable default state.
+        For this purpose, we use the DEFAULT SETTINGS defined at the top of this module.
+
+        The following procedure is followed:
+        - Stop the DDG to ensure it is not running.
+        - Then, we set the DEFAULT_IO_CONFIG for each channel, the trigger source to DEFAULT_TRIGGER_SOURCE,
+          and the channel references to DEFAULT_REFERENCES.
         """
-        self.burst_disable()  # it is possible to miss setting settings if burst is enabled
+        self.stop_ddg()
+
+        # NOTE Please adjust the default settings under 'DEFAULT SETTINGS' at the top of this module if needed.
+        # This makes sure that we have a well defined default state for the DDG2 device.
         for channel, config in DEFAULT_IO_CONFIG.items():
             self.set_io_values(channel, **config)
         self.set_trigger(DEFAULT_TRIGGER_SOURCE)
@@ -91,66 +136,76 @@ class DDG2(PSIDeviceBase, DelayGeneratorCSAXS):
 
     def on_stage(self) -> DeviceStatus | StatusBase | None:
         """
-        Stage logic for the DDG1 device, being th main trigger delay generator for CSAXS.
-        For standard scans, it will be triggered by a soft trigger from BEC.
-        It also has a hardware trigger feeded into the EXT/EN for fly-scanning, i.e. Galil stages.
 
-        This DDG is always not in burst mode.
+        This method is called when the device is staged before a scan. All information about the scan
+        is available through self.scan_info.msg at this point. The DDG2 needs to be configured to
+        create a sequence of TTL pulses in burst mode that are sent to the detectors. It therefore needs
+        to know the exposure time and frames per trigger from the self.scan_info.msg.scan_parameters.
+
+        This logic is robust for step scans as well as fly scans, as the DDG2 is triggered by the DDG1
+        through the EXT/EN channel.
         """
+        start_time = time.time()
+        ########################################
+        ### Burst mode settings ################
+        ########################################
+
+        # NOTE Only adjust settings if needed. DDG2 should always be in burst mode when used at CSAXS.
+        if self.burst_mode.get() == 0:
+            self.burst_mode.put(1)
+
+        # Ensure that there is no delay for the burst
+        if self.burst_delay.get() != 0:
+            self.burst_delay.put(0)
+
         exp_time = self.scan_info.msg.scan_parameters["exp_time"]
         frames_per_trigger = self.scan_info.msg.scan_parameters["frames_per_trigger"]
-        # a = t0
-        # a has reference to t0, b has reference to a
+
+        # NOTE Check if the exposure time is longer than all readout times.
+        # Raise a ValueError if requested exposure time is too short.
         if any(exp_time <= rt for rt in DEFAULT_READOUT_TIMES.values()):
             raise ValueError(
                 f"Exposure time {exp_time} is too short for the readout times {DEFAULT_READOUT_TIMES}"
             )
+
+        #########################################
+        ### Setup timing for burst and delays ###
+        #########################################
+
+        # Burst Period DDG2 settings. Only adjust them if needed.
+        if self.burst_count.get() != frames_per_trigger:
+            self.burst_count.put(frames_per_trigger)
+        if self.burst_period.get() != exp_time:
+            self.burst_period.put(exp_time)
+
+        # Calculate the pulse width for the channel pair 'ab'
         burst_pulse_width = exp_time - DEFAULT_READOUT_TIMES["ab"]
+
+        # Trigger detectors with delay 0, and pulse width = exp_time - readout_time
         self.set_delay_pairs(channel="ab", delay=0, width=burst_pulse_width)
-        self.burst_enable(count=frames_per_trigger, delay=0, period=exp_time)
+
+        logger.info(f"DDG {self.name} on_stage completed in {time.time() - start_time:.3f}s.")
 
     def on_pre_scan(self):
         """
-        The delay generator occasionally needs a bit extra time to process all
-        commands from stage. Therefore, we introduce here a short sleep
+
+        Method that is called just before a scan starts. It was observed that a short delay of 50ms
+        improves the overall stability in operation. This may be removed as other parts were adjusted,
+        but for now we will keep it as the delay is short.
         """
-        # Delay Generator occasionaly needs a bit extra time to process all commands, sleep 50ms
+        # NOTE Short delay to allow for the HW to process the commands before the scan starts.
+        # This may no longer be needed after other adjustments, and may be removed in the future.
         time.sleep(0.05)
 
     def on_trigger(self) -> DeviceStatus | StatusBase | None:
         """
-        DDG2 will not receive a trigger from BEC, but will be triggered by the DDG1 through the EXT/EN channel.
-        """
 
-    def wait_for_status(
-        self, status: DeviceStatus, bit_event: STATUSBITS, timeout: float = 5
-    ) -> None:
-        """Wait for a event status bit to be set.
-
-        Args:
-            status (StatusBase): The status object to update.
-            bit_event (STATUSBITS): The event status bit to wait for.
-            timeout (float): Maximum time to wait for the event status bit to be set.
+        DDG2 does not implement any trigger specific logic as it is triggered by DDG1 through the EXT/EN channel.
         """
-        current_time = time.time()
-        while not status.done:
-            self.state.proc_status.put(1, use_complete=True)
-            event_status = self.state.event_status.get()
-            if (STATUSBITS(event_status) & bit_event) == bit_event:
-                status.set_finished()
-            if time.time() - current_time > timeout:
-                status.set_exception(
-                    TimeoutError(
-                        f"Timeout waiting for status of device {self.name} for event_status {bit_event}"
-                    )
-                )
-                break
-            time.sleep(0.1)
-        time.sleep(0.05)  # Give time for the IOC to be ready again
-        return status
+        pass
 
     def on_stop(self) -> None:
-        """Stop the delay generator by setting the burst mode to 0"""
+        """Stop the delay generator"""
         self.stop_ddg()
 
 

csaxs_bec/devices/epics/delay_generator_csaxs/delay_generator_csaxs.py

@@ -3,6 +3,11 @@ Delay generator implementation for CSAXS.
 
 Detailed information can be found in the manual:
 https://www.thinksrs.com/downloads/pdfs/manuals/DG645m.pdf
+
+On the beamline consoles, the caqtdm panel can be started via:
+caqtdm -noMsg -attach -macro P=X12SA-CPCL-DDG,R=1: srsDG645.ui
+
+R=1,2,3 for 3 different DDG units installed at CSAXS.
 """
 
 import enum
@@ -151,8 +156,9 @@ class StatusBitsCompareStatus(SubscriptionStatus):
             run=run,
         )
 
-    def _compare_callback(self, value, **kwargs) -> bool:
+    def _compare_callback(self, *args, value, **kwargs) -> bool:
         """Callback for subscription status"""
+        logger.debug(f"StatusBitsCompareStatus: Received value {value}")
         obj = kwargs.get("obj", None)
         if obj is None:
             name = "no object received"
@@ -167,7 +173,9 @@ class StatusBitsCompareStatus(SubscriptionStatus):
             return False
         if self._add_delay != 0:
             time.sleep(self._add_delay)
-
+        logger.debug(
+            f"Returning comparison for {name}: {(STATUSBITS(value) & self._value) == self._value}"
+        )
         return (STATUSBITS(value) & self._value) == self._value
 
 
@@ -533,6 +541,7 @@ class DelayGeneratorCSAXS(Device):
         write_pv="BurstDelayAO",
         name="burst_delay",
         kind=Kind.omitted,
+        auto_monitor=True,
         doc="Delay before bursts start in seconds. Must be >=0.",
     )
     burst_period = Cpt(

csaxs_bec/devices/epics/falcon_csaxs.py

@@ -1,15 +1,17 @@
+"""Falcon Sitoro detector class for cSAXS beamline."""
+
 import enum
 import os
 import threading
+from typing import Literal
 
+from bec_lib.file_utils import get_full_path
 from bec_lib.logger import bec_logger
 from ophyd import Component as Cpt
-from ophyd import Device, EpicsSignal, EpicsSignalRO, EpicsSignalWithRBV
-from ophyd.mca import EpicsMCARecord
-from ophyd_devices.interfaces.base_classes.psi_detector_base import (
-    CustomDetectorMixin,
-    PSIDetectorBase,
-)
+from ophyd_devices import CompareStatus, FileEventSignal
+from ophyd_devices.devices.areadetector.plugins import HDF5Plugin_V35 as HDF5Plugin
+from ophyd_devices.devices.dxp import EpicsDXPFalcon, EpicsMCARecord, Falcon
+from ophyd_devices.interfaces.base_classes.psi_device_base import PSIDeviceBase
 
 logger = bec_logger.logger
 
@@ -18,15 +20,11 @@ class FalconError(Exception):
     """Base class for exceptions in this module."""
 
 
-class FalconTimeoutError(FalconError):
-    """Raised when the Falcon does not respond in time."""
-
-
-class DetectorState(enum.IntEnum):
+class ACQUIRESTATUS(enum.IntEnum):
     """Detector states for Falcon detector"""
 
     DONE = 0
-    ACQUIRING = 1
+    ACQUIRING = 1  # or Capturing
 
 
 class TriggerSource(enum.IntEnum):
@@ -44,238 +42,56 @@ class MappingSource(enum.IntEnum):
     MAPPING = 1
 
 
-class EpicsDXPFalcon(Device):
-    """
-    DXP parameters for Falcon detector
+class FalconControl(Falcon):
+    """Falcon Control class at cSAXS. prefix: 'X12SA-SITORO:'"""
 
-    Base class to map EPICS PVs from DXP parameters to ophyd signals.
+    dxp = Cpt(EpicsDXPFalcon, "dxp1:")
+    mca = Cpt(EpicsMCARecord, "mca1")
+    hdf5 = Cpt(HDF5Plugin, "HDF1:")
+
+
+class FalconcSAXS(PSIDeviceBase, FalconControl):
+    """
+    Falcon Sitoro detector for CSAXS
+
+
+    class attributes:
+        dxp (EpicsDXPFalcon)                    : DXP parameters for Falcon detector
+        mca (EpicsMCARecord)                    : MCA parameters for Falcon detector
+        hdf5 (FalconHDF5Plugins)                : HDF5 parameters for Falcon detector
+        MIN_READOUT (float)                     : Minimum readout time for the detector
     """
 
-    elapsed_live_time = Cpt(EpicsSignal, "ElapsedLiveTime")
-    elapsed_real_time = Cpt(EpicsSignal, "ElapsedRealTime")
-    elapsed_trigger_live_time = Cpt(EpicsSignal, "ElapsedTriggerLiveTime")
+    # specify minimum readout time for detector
+    MIN_READOUT = 3e-3
+    _pv_timeout = 3  # Timeout for PV operations in seconds
 
-    # Energy Filter PVs
-    energy_threshold = Cpt(EpicsSignalWithRBV, "DetectionThreshold")
-    min_pulse_separation = Cpt(EpicsSignalWithRBV, "MinPulsePairSeparation")
-    detection_filter = Cpt(EpicsSignalWithRBV, "DetectionFilter", string=True)
-    scale_factor = Cpt(EpicsSignalWithRBV, "ScaleFactor")
-    risetime_optimisation = Cpt(EpicsSignalWithRBV, "RisetimeOptimization")
-
-    # Misc PVs
-    detector_polarity = Cpt(EpicsSignalWithRBV, "DetectorPolarity")
-    decay_time = Cpt(EpicsSignalWithRBV, "DecayTime")
-
-    current_pixel = Cpt(EpicsSignalRO, "CurrentPixel")
-
-
-class FalconHDF5Plugins(Device):
-    """
-    HDF5 parameters for Falcon detector
-
-    Base class to map EPICS PVs from HDF5 Plugin to ophyd signals.
-    """
-
-    capture = Cpt(EpicsSignalWithRBV, "Capture")
-    enable = Cpt(EpicsSignalWithRBV, "EnableCallbacks", string=True, kind="config")
-    xml_file_name = Cpt(EpicsSignalWithRBV, "XMLFileName", string=True, kind="config")
-    lazy_open = Cpt(EpicsSignalWithRBV, "LazyOpen", string=True, doc="0='No' 1='Yes'")
-    temp_suffix = Cpt(EpicsSignalWithRBV, "TempSuffix", string=True)
-    file_path = Cpt(EpicsSignalWithRBV, "FilePath", string=True, kind="config")
-    file_name = Cpt(EpicsSignalWithRBV, "FileName", string=True, kind="config")
-    file_template = Cpt(EpicsSignalWithRBV, "FileTemplate", string=True, kind="config")
-    num_capture = Cpt(EpicsSignalWithRBV, "NumCapture", kind="config")
-    file_write_mode = Cpt(EpicsSignalWithRBV, "FileWriteMode", kind="config")
-    queue_size = Cpt(EpicsSignalWithRBV, "QueueSize", kind="config")
-    array_counter = Cpt(EpicsSignalWithRBV, "ArrayCounter", kind="config")
-
-
-class FalconSetup(CustomDetectorMixin):
-    """
-    Falcon setup class for cSAXS
-
-    Parent class: CustomDetectorMixin
-
-    """
-
-    def __init__(self, *args, parent: Device = None, **kwargs) -> None:
-        super().__init__(*args, parent=parent, **kwargs)
-        self._lock = threading.RLock()
+    file_event = Cpt(FileEventSignal, name="file_event")
 
     def on_init(self) -> None:
-        """Initialize Falcon detector"""
-        self.initialize_default_parameter()
-        self.initialize_detector()
-        self.initialize_detector_backend()
+        """Initialize Falcon Sitoro detector"""
+        self._lock = threading.RLock()
+        self._readout_time = self.MIN_READOUT
+        self._value_pixel_per_buffer = 20
+        self._queue_size = 2000
+        self._full_path = ""
 
-    def initialize_default_parameter(self) -> None:
+    def on_connected(self):
         """
-        Set default parameters for Falcon
-
-        This will set:
-        - readout (float): readout time in seconds
-        - value_pixel_per_buffer (int): number of spectra in buffer of Falcon Sitoro
-
+        Setup Falcon Sitoro detector default parameters once signals are connected
         """
-        self.parent.value_pixel_per_buffer = 20
-        self.update_readout_time()
-
-    def update_readout_time(self) -> None:
-        """Set readout time for Eiger9M detector"""
-        readout_time = (
-            self.parent.scaninfo.readout_time
-            if hasattr(self.parent.scaninfo, "readout_time")
-            else self.parent.MIN_READOUT
-        )
-        self.parent.readout_time = max(readout_time, self.parent.MIN_READOUT)
-
-    def initialize_detector(self) -> None:
-        """Initialize Falcon detector"""
-        self.stop_detector()
-        self.stop_detector_backend()
+        self.on_stop()
+        self._initialize_detector()
+        self._initialize_detector_backend()
         self.set_trigger(
             mapping_mode=MappingSource.MAPPING, trigger_source=TriggerSource.GATE, ignore_gate=0
         )
-        # 1 Realtime
-        self.parent.preset_mode.put(1)
-        # 0 Normal, 1 Inverted
-        self.parent.input_logic_polarity.put(0)
-        # 0 Manual 1 Auto
-        self.parent.auto_pixels_per_buffer.put(0)
-        # Sets the number of pixels/spectra in the buffer
-        self.parent.pixels_per_buffer.put(self.parent.value_pixel_per_buffer)
-
-    def initialize_detector_backend(self) -> None:
-        """Initialize the detector backend for Falcon."""
-        self.parent.hdf5.enable.put(1)
-        # file location of h5 layout for cSAXS
-        self.parent.hdf5.xml_file_name.put("layout.xml")
-        # TODO Check if lazy open is needed and wanted!
-        self.parent.hdf5.lazy_open.put(1)
-        self.parent.hdf5.temp_suffix.put("")
-        # size of queue for number of spectra allowed in the buffer, if too small at high throughput, data is lost
-        self.parent.hdf5.queue_size.put(2000)
-        # Segmentation into Spectra within EPICS, 1 is activate, 0 is deactivate
-        self.parent.nd_array_mode.put(1)
-
-    def on_stage(self) -> None:
-        """Prepare detector and backend for acquisition"""
-        self.prepare_detector()
-        self.prepare_data_backend()
-        self.publish_file_location(done=False, successful=False)
-        self.arm_acquisition()
-
-    def prepare_detector(self) -> None:
-        """Prepare detector for acquisition"""
-        self.set_trigger(
-            mapping_mode=MappingSource.MAPPING, trigger_source=TriggerSource.GATE, ignore_gate=0
-        )
-        self.parent.preset_real.put(self.parent.scaninfo.exp_time)
-        self.parent.pixels_per_run.put(
-            int(self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger)
-        )
-
-    def prepare_data_backend(self) -> None:
-        """Prepare data backend for acquisition"""
-        self.parent.filepath.set(
-            self.parent.filewriter.compile_full_filename(f"{self.parent.name}.h5")
-        ).wait()
-        file_path, file_name = os.path.split(self.parent.filepath.get())
-        self.parent.hdf5.file_path.put(file_path)
-        self.parent.hdf5.file_name.put(file_name)
-        self.parent.hdf5.file_template.put("%s%s")
-        self.parent.hdf5.num_capture.put(
-            int(self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger)
-        )
-        self.parent.hdf5.file_write_mode.put(2)
-        # Reset spectrum counter in filewriter, used for indexing & identifying missing triggers
-        self.parent.hdf5.array_counter.put(0)
-        # Start file writing
-        self.parent.hdf5.capture.put(1)
-
-    def arm_acquisition(self) -> None:
-        """Arm detector for acquisition"""
-        self.parent.start_all.put(1)
-        signal_conditions = [
-            (
-                lambda: self.parent.state.read()[self.parent.state.name]["value"],
-                DetectorState.ACQUIRING,
-            )
-        ]
-        if not self.wait_for_signals(
-            signal_conditions=signal_conditions,
-            timeout=self.parent.TIMEOUT_FOR_SIGNALS,
-            check_stopped=True,
-            all_signals=False,
-        ):
-            raise FalconTimeoutError(
-                f"Failed to arm the acquisition. Detector state {signal_conditions[0][0]}"
-            )
-
-    def on_unstage(self) -> None:
-        """Unstage detector and backend"""
-        pass
-
-    def on_complete(self) -> None:
-        """Complete detector and backend"""
-        self.finished(timeout=self.parent.TIMEOUT_FOR_SIGNALS)
-        self.publish_file_location(done=True, successful=True)
-
-    def on_stop(self) -> None:
-        """Stop detector and backend"""
-        self.stop_detector()
-        self.stop_detector_backend()
-
-    def stop_detector(self) -> None:
-        """Stops detector"""
-
-        self.parent.stop_all.put(1)
-        self.parent.erase_all.put(1)
-
-        signal_conditions = [
-            (lambda: self.parent.state.read()[self.parent.state.name]["value"], DetectorState.DONE)
-        ]
-
-        if not self.wait_for_signals(
-            signal_conditions=signal_conditions,
-            timeout=self.parent.TIMEOUT_FOR_SIGNALS - self.parent.TIMEOUT_FOR_SIGNALS // 2,
-            all_signals=False,
-        ):
-            # Retry stop detector and wait for remaining time
-            raise FalconTimeoutError(
-                f"Failed to stop detector, timeout with state {signal_conditions[0][0]}"
-            )
-
-    def stop_detector_backend(self) -> None:
-        """Stop the detector backend"""
-        self.parent.hdf5.capture.put(0)
-
-    def finished(self, timeout: int = 5) -> None:
-        """Check if scan finished succesfully"""
-        with self._lock:
-            total_frames = int(
-                self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger
-            )
-            signal_conditions = [
-                (self.parent.dxp.current_pixel.get, total_frames),
-                (self.parent.hdf5.array_counter.get, total_frames),
-            ]
-            if not self.wait_for_signals(
-                signal_conditions=signal_conditions,
-                timeout=timeout,
-                check_stopped=True,
-                all_signals=True,
-            ):
-                logger.debug(
-                    f"Falcon missed a trigger: received trigger {self.parent.dxp.current_pixel.get()},"
-                    f" send data {self.parent.hdf5.array_counter.get()} from total_frames"
-                    f" {total_frames}"
-                )
-            self.stop_detector()
-            self.stop_detector_backend()
 
     def set_trigger(
-        self, mapping_mode: MappingSource, trigger_source: TriggerSource, ignore_gate: int = 0
+        self,
+        mapping_mode: MappingSource,
+        trigger_source: TriggerSource,
+        ignore_gate: Literal[0, 1] = 0,
     ) -> None:
         """
         Set triggering mode for detector
@@ -287,63 +103,140 @@ class FalconSetup(CustomDetectorMixin):
 
         """
         mapping = int(mapping_mode)
-        trigger = trigger_source
-        self.parent.collect_mode.put(mapping)
-        self.parent.pixel_advance_mode.put(trigger)
-        self.parent.ignore_gate.put(ignore_gate)
+        trigger = int(trigger_source)
+        self.collect_mode.put(mapping)
+        self.pixel_advance_mode.put(trigger)
+        self.ignore_gate.put(ignore_gate)
 
+    def _initialize_detector(self) -> None:
+        """Initialize Falcon detector"""
 
-class FalconcSAXS(PSIDetectorBase):
-    """
-    Falcon Sitoro detector for CSAXS
+        # 1 Realtime
+        self.preset_mode.put(1)
 
-    Parent class: PSIDetectorBase
+        # 0 Normal, 1 Inverted
+        self.input_logic_polarity.put(0)
 
-    class attributes:
-        custom_prepare_cls (FalconSetup)        : Custom detector setup class for cSAXS,
-                                                  inherits from CustomDetectorMixin
-        PSIDetectorBase.set_min_readout (float) : Minimum readout time for the detector
-        dxp (EpicsDXPFalcon)                    : DXP parameters for Falcon detector
-        mca (EpicsMCARecord)                    : MCA parameters for Falcon detector
-        hdf5 (FalconHDF5Plugins)                : HDF5 parameters for Falcon detector
-        MIN_READOUT (float)                     : Minimum readout time for the detector
-    """
+        # 0 Manual 1 Auto
+        self.auto_pixels_per_buffer.put(0)
 
-    # Specify which functions are revealed to the user in BEC client
-    USER_ACCESS = ["describe"]
+        # Sets the number of pixels/spectra in the buffer
+        self.pixels_per_buffer.put(self._value_pixel_per_buffer)
 
-    # specify Setup class
-    custom_prepare_cls = FalconSetup
-    # specify minimum readout time for detector
-    MIN_READOUT = 3e-3
-    TIMEOUT_FOR_SIGNALS = 5
+    def _initialize_detector_backend(self) -> None:
+        """Initialize the detector backend for Falcon."""
+        # Enable HDF5 plugin
+        self.hdf5.enable.put(1)
 
-    # specify class attributes
-    dxp = Cpt(EpicsDXPFalcon, "dxp1:")
-    mca = Cpt(EpicsMCARecord, "mca1")
-    hdf5 = Cpt(FalconHDF5Plugins, "HDF1:")
+        # Use layout.xml file for cSAXS Falcon. FIXME:Should be checked if IOC runs on different host.
+        self.hdf5.xml_file_name.put("layout.xml")
 
-    stop_all = Cpt(EpicsSignal, "StopAll")
-    erase_all = Cpt(EpicsSignal, "EraseAll")
-    start_all = Cpt(EpicsSignal, "StartAll")
-    state = Cpt(EpicsSignal, "Acquiring")
-    preset_mode = Cpt(EpicsSignal, "PresetMode")  # 0 No preset 1 Real time 2 Events 3 Triggers
-    preset_real = Cpt(EpicsSignal, "PresetReal")
-    preset_events = Cpt(EpicsSignal, "PresetEvents")
-    preset_triggers = Cpt(EpicsSignal, "PresetTriggers")
-    triggers = Cpt(EpicsSignalRO, "MaxTriggers", lazy=True)
-    events = Cpt(EpicsSignalRO, "MaxEvents", lazy=True)
-    input_count_rate = Cpt(EpicsSignalRO, "MaxInputCountRate", lazy=True)
-    output_count_rate = Cpt(EpicsSignalRO, "MaxOutputCountRate", lazy=True)
-    collect_mode = Cpt(EpicsSignal, "CollectMode")  # 0 MCA spectra, 1 MCA mapping
-    pixel_advance_mode = Cpt(EpicsSignal, "PixelAdvanceMode")
-    ignore_gate = Cpt(EpicsSignal, "IgnoreGate")
-    input_logic_polarity = Cpt(EpicsSignal, "InputLogicPolarity")
-    auto_pixels_per_buffer = Cpt(EpicsSignal, "AutoPixelsPerBuffer")
-    pixels_per_buffer = Cpt(EpicsSignal, "PixelsPerBuffer")
-    pixels_per_run = Cpt(EpicsSignal, "PixelsPerRun")
-    nd_array_mode = Cpt(EpicsSignal, "NDArrayMode")
+        # TODO Check if lazy open is needed and wanted!
+        self.hdf5.lazy_open.put(1)
+        self.hdf5.temp_suffix.put("")
+
+        # Size of the queue for the number of spectra allowed in the buffer. If too small, data is lost at high throughput
+        self.hdf5.queue_size.put(self._queue_size)
+        self.hdf5.file_template.put("%s%s")
+        self.hdf5.file_write_mode.put(2)
+
+        # Set nd_array mode to 1: This means segmentation into Spectra within EPICS, 1 is activate, 0 is deactivate
+        self.nd_array_mode.put(1)
+
+    def on_stage(self):
+        """
+        This method is called when the detector is staged for acquisition.
+        We use the information in scan_info.msg about the upcoming scan to set all relevant parameters on the detector.
+        """
+        # Calculate relevant parameters
+        num_points = self.scan_info.msg.num_points
+        frames_per_trigger = self.scan_info.msg.scan_parameters.get("frames_per_trigger", 1)
+        overall_frames = int(num_points * frames_per_trigger)
+        exp_time = self.scan_info.msg.scan_parameters["exp_time"]
+        self._full_path = get_full_path(self.scan_info.msg, self.name)
+
+        # Check that exposure time is larger than readout time
+        readout_time = max(
+            self.scan_info.msg.scan_parameters.get("readout_time", self.MIN_READOUT),
+            self.MIN_READOUT,
+        )
+        if exp_time < readout_time:
+            raise ValueError(
+                f"Exposure time {exp_time} is less than minimum readout time {readout_time}"
+            )
+
+        # TODO: Add h5_entries for linking the Falcon NEXUS entries with the master file
+        self.file_event.put(file_path=self._full_path, done=False, successful=False)
+
+        self.preset_real_time.put(exp_time)
+        self.pixels_per_run.put(overall_frames)
+
+        # Prepare detector backend PVs
+        file_path, file_name = os.path.split(self._full_path)
+        self.hdf5.file_path.put(file_path)
+        self.hdf5.file_name.put(file_name)
+
+        self.hdf5.num_capture.put(overall_frames)
+        # Reset spectrum counter in filewriter, used for indexing & identifying missing triggers
+        self.hdf5.array_counter.put(0)
+
+        # Start file writing
+        self.hdf5.capture.put(1)
+        # Start the acquisition
+        self.start_all.put(1)
+
+    def on_pre_scan(self):
+        """
+        Method for actions just before the scan starts.
+        """
+        status_camera = CompareStatus(
+            self.acquire_busy, ACQUIRESTATUS.ACQUIRING, timeout=self._pv_timeout
+        )
+        status_writer = CompareStatus(
+            self.hdf5.capture, ACQUIRESTATUS.ACQUIRING, timeout=self._pv_timeout
+        )
+        # Logical combine of statuses
+        status = status_camera & status_writer
+        self.cancel_on_stop(status)
+        return status
+
+    def _complete_callback(self, status: CompareStatus) -> None:
+        """Callback for when the device completes a scan."""
+        # FIXME Add proper h5 entries once checked
+        if status.success:
+            self.file_event.put(
+                file_path=self._full_path,  # pylint: disable:protected-access
+                done=True,
+                successful=True,
+            )
+        else:
+            self.file_event.put(
+                file_path=self._full_path,  # pylint: disable:protected-access
+                done=True,
+                successful=False,
+            )
+
+    def on_complete(self) -> None:
+        """Complete detector and backend"""
+        # Calculate relevant parameters
+        num_points = self.scan_info.msg.num_points
+        frames_per_trigger = self.scan_info.msg.scan_parameters.get("frames_per_trigger", 1)
+        overall_frames = int(num_points * frames_per_trigger)
+
+        status_detector = CompareStatus(self.dxp.current_pixel, overall_frames, run=True)
+        status_backend = CompareStatus(self.hdf5.array_counter, overall_frames, run=True)
+
+        status = status_detector & status_backend
+        self.cancel_on_stop(status)
+        status.add_callback(self._complete_callback)
+        return status
+
+    def on_stop(self) -> None:
+        """Stop detector and backend"""
+        self.stop_all.put(1)
+        self.hdf5.capture.put(0)
+        self.erase_all.put(1)
 
 
 if __name__ == "__main__":
-    falcon = FalconcSAXS(name="falcon", prefix="X12SA-SITORO:", sim_mode=True)
+    falcon = FalconcSAXS(name="falcon", prefix="X12SA-SITORO:")

csaxs_bec/devices/epics/mcs_card/README.md

@@ -0,0 +1,13 @@
+# MCS Card implementation at the CSAXS beamline
+
+This module provides an ophyd device implementation for the SIS3820 Multi-Channel Scaler (MCS) card, used at the cSAXS beamline for time-resolved data acquisition. It interfaces with the EPICS IOC for the SIS3820 MCS card.
+Information about the EPICS driver can be found here (https://millenia.cars.aps.anl.gov/software/epics/mcaStruck.html).
+
+# Important Notes
+Operation of the MCS card requires proper configuration as some of the parameters are interdependent. In addition, empirical adjustments have been found to be necessary for optimal performance at the beamline. In its current implementation, comments about these dependencies are highlighted in the source code of the ophyd device classes [MCSCard](./mcs_card.py) and [MCSCardCSAXS](./mcs_card_csaxs.py). It is highly recommended to review these comments before refactoring, modifying, or extending the code.
+
+## Ophyd Device Implementation
+
+The ophyd device implementation is provided [MCSCard](./mcs_card.py). This class provides a basic interface to the MCS PVs, including configuration of parameters such as number of channels, dwell time, and control of acquisition start/stop. Please check the source code of the class for more details of the implementation. 
+
+The [MCSCardCSAXS](./mcs_card_csaxs.py) class extends the basic MCSCard implementation with cSAXS-specific logic and configurations. Please be aware that this is also linked to the implementation of other devices, most notably the [delay generator integration](../delay_generator_csaxs/README.md), which is used as the trigger source for the MCS card during operation.

csaxs_bec/devices/epics/mcs_card/mcs_card.py

@@ -170,11 +170,12 @@ class MCSCard(Device):
         kind=Kind.omitted,
         doc="Indicates whether the SNL program has connected to all PVs.",
     )
+    # NOTE: Please note that the erase_all command sends the mca or waveform records to process after erasing, potentially also values of 0. This logic needs to be considered when running callbacks on the mca channels.
     erase_all = Cpt(
         EpicsSignal,
         "EraseAll",
         kind=Kind.omitted,
-        doc="Erases all mca or waveform records, setting elapsed times and counts in all channels to 0.",
+        doc="Erases all mca or waveform records, setting elapsed times and counts in all channels to 0. Please note that this operation sends the mca or waveform records to process after erasing, potentially also 0s.",
     )
     erase_start = Cpt(
         EpicsSignal,
@@ -192,6 +193,7 @@ class MCSCard(Device):
         EpicsSignalRO,
         "Acquiring",
         kind=Kind.omitted,
+        auto_monitor=True,
         doc="Acquiring (=1) when acquisition is in progress and Done (=0) when acquisition is complete.",
     )
     stop_all = Cpt(EpicsSignal, "StopAll", kind=Kind.omitted, doc="Stops acquisition.")
@@ -279,11 +281,12 @@ class MCSCard(Device):
         kind=Kind.omitted,
         doc="The current acquisition mode (MCS=0 or Scaler=1). This record is used to turn off the scaler record Autocount in MCS mode.",
     )
+    # NOTE: Setting mux_output programmatically results in occasional errors on the IOC; it is recommended to avoid using it.
     mux_output = Cpt(
         EpicsSignal,
         "MUXOutput",
         kind=Kind.omitted,
-        doc="Value of 0-32 used to select which input signal is routed to output signal 7 on the SIS3820 in output mode 3.",
+        doc="Value of 0-32 used to select which input signal is routed to output signal 7 on the SIS3820 in output mode 3. NOTE: This settings seems to occasionally result in errors on the IOC; it is recommended to avoid using it.",
     )
     user_led = Cpt(
         EpicsSignal,

csaxs_bec/devices/epics/mcs_card/mcs_card_csaxs.py

@@ -1,16 +1,28 @@
-"""Module for the MCSCard CSAXS implementation."""
+"""
+Module for the MCSCard CSAXS implementation at cSAXS.
+
+Please respect the comments regarding timing and procedures of the MCS card. These
+are highlighted with NOTE comments directly in the code, indicating requirements
+for stable device operation. Most of these constraints were identified
+empirically through extensive testing with the SIS3820 MCS card IOC and are intended
+to prevent unexpected hardware or IOC behavior.
+"""
 
 from __future__ import annotations
 
-import enum
+import threading
+import time
+import traceback
+from contextlib import contextmanager
+from functools import partial
 from threading import RLock
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Callable, Literal
 
 import numpy as np
 from bec_lib.logger import bec_logger
 from ophyd import Component as Cpt
-from ophyd import Device, EpicsSignalRO, Kind, Signal
-from ophyd_devices import CompareStatus, ProgressSignal, TransitionStatus
+from ophyd import EpicsSignalRO, Kind
+from ophyd_devices import AsyncMultiSignal, CompareStatus, ProgressSignal, StatusBase
 from ophyd_devices.interfaces.base_classes.psi_device_base import PSIDeviceBase
 
 from csaxs_bec.devices.epics.mcs_card.mcs_card import (
@@ -24,7 +36,37 @@ from csaxs_bec.devices.epics.mcs_card.mcs_card import (
     READMODE,
     MCSCard,
 )
-from csaxs_bec.devices.epics.xbpms import DiffXYSignal, SumSignal
+
+
+@contextmanager
+def suppress_mca_callbacks(mcs_card: MCSCard, restore_after_timeout: None | float = None):
+    """
+    Utility context manager to suppress MCA channel callbacks temporarily.
+    It is required because erasing all channels via 'erase_all' PV triggers
+    callbacks for each channel. Depending on timing, this can interfere with
+    ongoing data acquisition so this context manager can be used to suppress
+    those callbacks temporarily. If used with restore_after_timeout, the suppression
+    will be automatically cleared after the specified timeout in seconds.
+
+    NOTE: Please be aware that it does not restore previous state, which means
+    that _omit_mca_callbacks will remain set after exiting the context. It has
+    to be cleared manually if needed. This can be improved in the future, but
+    should be carefully coordinated with the logic implemented within '_on_counter_update'.
+
+    Args:
+        mcs_card (MCSCard): The MCSCard instance to suppress callbacks for.
+        restore_after_timeout (float | None): Optional timeout in seconds to automatically
+            clear the suppression after the specified time. If None, the original state
+            is not restored.
+    """
+    mcs_card._omit_mca_callbacks.set()  # pylint: disable=protected-access
+    try:
+        yield
+    finally:
+        if restore_after_timeout is not None:
+            time.sleep(restore_after_timeout)
+            mcs_card._omit_mca_callbacks.clear()  # pylint: disable=protected-access
+
 
 if TYPE_CHECKING:  # pragma: no cover
     from bec_lib.devicemanager import DeviceManagerBase, ScanInfo
@@ -32,76 +74,50 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = bec_logger.logger
 
 
-class READYTOREAD(int, enum.Enum):
-
-    PROCESSING = 0
-    DONE = 1
-
-
-class BPMDevice(Device):
-    """Class for BPM device of the MCSCard."""
-
-    current1 = Cpt(Signal, kind=Kind.normal, doc="Normalized current 1")
-    current2 = Cpt(Signal, kind=Kind.normal, doc="Normalized current 2")
-    current3 = Cpt(Signal, kind=Kind.normal, doc="Normalized current 3")
-    current4 = Cpt(Signal, kind=Kind.normal, doc="Normalized current 4")
-    count_time = Cpt(Signal, kind=Kind.normal, doc="Count time for bpm signal counts")
-    sum = Cpt(SumSignal, kind="hinted", doc="Sum of all currents")
-    x = Cpt(
-        DiffXYSignal,
-        sum1=["current1", "current2"],
-        sum2=["current3", "current4"],
-        doc="X difference signal",
-    )
-    y = Cpt(
-        DiffXYSignal,
-        sum1=["current1", "current3"],
-        sum2=["current2", "current4"],
-        doc="Y difference signal",
-    )
-    diag = Cpt(
-        DiffXYSignal,
-        sum1=["current1", "current4"],
-        sum2=["current2", "current3"],
-        doc="Diagonal difference signal",
-    )
-
-
-class MCSRaw(Device):
-    """Class for BPM device of the MCSCard with normalized currents."""
-
-    mca1 = Cpt(Signal, kind=Kind.normal, doc="Raw counts on mca1 channel")
-    mca2 = Cpt(Signal, kind=Kind.normal, doc="Raw counts on mca2 channel")
-    mca3 = Cpt(Signal, kind=Kind.normal, doc="Raw counts on mca3 channel")
-    mca4 = Cpt(Signal, kind=Kind.normal, doc="Raw counts on mca4 channel")
-    mca5 = Cpt(Signal, kind=Kind.normal, doc="Raw counts on mca5 channel")
-
-
 class MCSCardCSAXS(PSIDeviceBase, MCSCard):
     """
     Implementation of the MCSCard SIS3820 for CSAXS, prefix 'X12SA-MCS:'.
     The basic functionality is inherited from the MCSCard class.
+
+    Please note that the number of channels is fixed to 32, so there will be data for all
+    32 channels. In addition, the logic of the card is linked to the timing system (DDG)
+    and therefore changes have to be coordinated with the logic on the DDG side.
+
+    Args:
+        name (str): Name of the device.
+        prefix (str, optional): Prefix for the EPICS PVs. Defaults to "".
     """
 
-    ready_to_read = Cpt(
-        Signal,
-        kind=Kind.omitted,
-        doc="Signal that indicates if mcs card is ready to be read from after triggers. 0 not ready, 1 ready",
-    )
-    progress: ProgressSignal = Cpt(ProgressSignal, name="progress")
-    # Make this an async signal..
-    mcs = Cpt(
-        MCSRaw,
-        name="mcs",
+    USER_ACCESS = ["mcs_recovery"]
+
+    # NOTE The number of MCA channels is fixed to 32 for the CSAXS MCS card.
+    # On the IOC, we receive a 'warning' or 'error' once we set this channel for the
+    # envisioned input/output mode settings of the card. However, we need to know the
+    # channels set as callback timing relies on the channels to be set.
+    # For the future, we may consider adding an initialization parameter to set
+    # the number of channels, which in return limits the number of subscriptions
+    # on the channels. However, mux_output should still be set to 32 on the IOC side.
+    # If this limits performance, this should be investigated with Controls engineers and
+    # the IOC.
+    NUM_MCA_CHANNELS: int = 32
+
+    # MCA counters for the card. Channels 1-32 will be sent to BEC.
+    mca = Cpt(
+        AsyncMultiSignal,
+        name="counters",
+        signals=[
+            f"mca{i}" for i in range(1, 33)
+        ],  # NOTE Channels 1-32, they need to be in sync with the 'counters' component (DynamicDeviceComponent) of the MCSCard
+        ndim=1,
+        async_update={"type": "add", "max_shape": [None]},
+        max_size=1000,
         kind=Kind.normal,
-        doc="MCS device with raw current and count time readings",
-    )
-    bpm = Cpt(
-        BPMDevice,
-        name="bpm",
-        kind=Kind.normal,
-        doc="BPM device for MCSCard with count times and normalized currents",
+        doc=(
+            "AsyncMultiSignal for MCA card channels 1-32."
+            "Cabling of the MCS card determines which channel corresponds to which input."
+        ),
     )
+    progress = Cpt(ProgressSignal, doc="ProgressSignal indicating the progress of the device")
 
     def __init__(
         self,
@@ -111,39 +127,77 @@ class MCSCardCSAXS(PSIDeviceBase, MCSCard):
         device_manager: DeviceManagerBase | None = None,
         **kwargs,
     ):
-        """
-        Initialize the MCSCardCSAXS with the given arguments and keyword arguments.
-        """
         super().__init__(
             name=name, prefix=prefix, scan_info=scan_info, device_manager=device_manager, **kwargs
         )
+        # NOTE MCS Clock frequency. This is linked to the settings of the SIS3820 IOC and
+        # cabeling of the card. Currently, the 'output_mode' is set to MODE_2 and one of the outputs
+        # 6 or 7 (both 10MHz clocks) is used on channel 5 input for the timing signal of the IOC.
+        # Please adjust this comment if the cabling or IOC settings change.
         self._mcs_clock = 1e7  # 10MHz clock ->  1e7 Hz
-        self._pv_timeout = 3  # TODO remove timeout once #129 in ophyd_devices is solved
-        self._rlock = RLock()  # Needed to ensure thread safety for counter updates
-        self.counter_mapping = {  # Any mca counter that should be updated has to be added here
-            f"{self.counters.name}_mca1": "current1",
-            f"{self.counters.name}_mca2": "current2",
-            f"{self.counters.name}_mca3": "current3",
-            f"{self.counters.name}_mca4": "current4",
-            f"{self.counters.name}_mca5": "count_time",
-        }
-        self.counter_updated = []
+        self._pv_timeout = 2.0  # seconds
+        self._rlock = RLock()
+
+        # NOTE This parameter will be sent with async data of the mcs counters.
+        # Based on scan-paramters, e.g. frames_per_trigger, this will be either
+        # 'monitored' or 'burst_group'. This means whether data from this channel
+        # is in sync with monitored devices or another group. In this scenario,
+        # the other group is called burst_group. Other detectors connected and
+        # triggered through the same timing system should implement the same logic
+        # to allow data to be properly grouped afterwards.
+        self._acquisition_group: str = "monitored"  # default value, will be updated in on_stage
+        self._num_total_triggers: int = 0
+
+        # Thread and event logic for monitoring async data emission after scan is done
+        # These are mostly internal variables for which values should not be changed externally.
+        # Adjusting the logic of them should also be handled with care and proper testing.
+        self._scan_done_thread_kill_event: threading.Event = threading.Event()
+        self._start_monitor_async_data_emission: threading.Event = threading.Event()
+        self._scan_done_callbacks: list[Callable[[], None]] = []
+        self._scan_done_thread: threading.Thread = threading.Thread(
+            target=self._monitor_async_data_emission, daemon=True
+        )
+        self._current_data_index: int = 0
+        self._mca_counter_index: int = 0
+        self._current_data: dict[str, dict[Literal["value", "timestamp"], list[int] | float]] = {}
+        self._omit_mca_callbacks: threading.Event = threading.Event()
 
     def on_connected(self):
         """
-        Called when the device is connected.
+        This method is called once the device and all its PVs are connected. Any initial
+        setup of PVs should be managed here. Please be aware that settings of the MCS card
+        correlate with its operation mode, input/output modes, and timing. Changing single
+        parameters without understanding the overall logic may lead to unexpected behavior
+        of the device.Therefore, any modification of these parameters should be handled
+        with care and tested.
+
+        A brief summary of the procesdure that is implemented here:
+        - Stop any ongoing acquisiton.
+        - Setup the Initial initial settings of the MCS card with respective operation modes
+        - Run 'mcs_recovery' procedure to ensure that no pending acquisition data is scheduled
+            to be pushed through mcs channels
+        - Subscribe a callback '_on_counter_update' to mcs counter PVs to forward
+            data through AsyncMultiSignal to BEC
+        - Start the monitoring thread for async data emission after scan is done
         """
-        # Make sure card is not running
+        # NOTE Stop any ongoing acquisition first. This shut be done before setting any PVs.
         self.stop_all.put(1)
 
-        # TODO Check channel1_source !!
+        #########################
+        ### Setup MCS Card ###
+        #########################
+        # Setup the MCS card settings. Please note that any runtime modification
+        # these parameter may lead to unexpected behavior of the device.
+        # Therefore this has to be set up correctly.
         self.channel_advance.set(CHANNELADVANCE.EXTERNAL).wait(timeout=self._pv_timeout)
         self.channel1_source.set(CHANNEL1SOURCE.EXTERNAL).wait(timeout=self._pv_timeout)
         self.prescale.set(1).wait(timeout=self._pv_timeout)
-        # Set the user LED to off
         self.user_led.set(0).wait(timeout=self._pv_timeout)
-        # Only channel 1-5 are connected so far, adjust if more are needed
-        self.mux_output.set(5).wait(timeout=self._pv_timeout)
+
+        # NOTE The number of output channels has to be set to NUM_MCA_CHANNELS.
+        # The logic to send data to BEC relies on knowing how many channels are active.
+        self.mux_output.put(self.NUM_MCA_CHANNELS)
+
         # Set the input and output modes & polarities
         self.input_mode.set(INPUTMODE.MODE_3).wait(timeout=self._pv_timeout)
         self.input_polarity.set(POLARITY.NORMAL).wait(timeout=self._pv_timeout)
@@ -151,134 +205,334 @@ class MCSCardCSAXS(PSIDeviceBase, MCSCard):
         self.output_polarity.set(POLARITY.NORMAL).wait(timeout=self._pv_timeout)
         self.count_on_start.set(0).wait(timeout=self._pv_timeout)
 
-        # Set appropriate read mode
+        # NOTE Data is read out when the MCS card finishes an acquisition. The logic for this
+        # is also linked to triggering on the DDG.
+        # Set ReadMode to PASSIVE, the card will wait either wait for readout command or
+        # automatically readout once acquisition is done.
         self.read_mode.set(READMODE.PASSIVE).wait(timeout=self._pv_timeout)
 
         # Set the acquire mode
         self.acquire_mode.set(ACQUIREMODE.MCS).wait(timeout=self._pv_timeout)
 
         # Subscribe the progress signal
-        # self.current_channel.subscribe(self._progress_update, run=False)
+        self.current_channel.subscribe(self._progress_update, run=False)
 
-        # Subscribe to the mca updates
-        for name in self.counter_mapping.keys():
-            sig: EpicsSignalRO = getattr(self.counters, name.split("_")[-1])
-            sig.subscribe(self._on_counter_update, run=False)
+        # NOTE: Run a recovery procedure to ensure that the card has no pending data
+        # that needs to be pushed through the mca channels. The procedure involves
+        # stopping any ongoing acquisition and erasing all data on the card. Including
+        # a short sleep to allow the IOC to process the commands.
+        self.mcs_recovery(timeout=1)
 
-    def _on_counter_update(self, value, **kwargs) -> None:
+        ####################################
+        ### Setup MCS Subscriptions ###
+        ####################################
+        for sig in self.counters.component_names:
+            sig_obj: EpicsSignalRO = getattr(self.counters, sig)
+            sig_obj.subscribe(self._on_counter_update, run=False)
+
+        # Start monitoring thread
+        self._scan_done_thread.start()
+
+    def _on_counter_update(self, value: float | np.ndarray, **kwargs) -> None:
         """
-        Callback for counter updates of the mca channels (1-32).
+        Callback for counter updates of the mca channels (1-32). This callback is attached
+        to each mca channel PV on the MCS card. It collects data from all channels
+        and once all channels have been updated for a given acquisition, it pushes
+        the data to BEC through the AsyncMultiSignal 'mca'.
 
-        The raw data is pushed to the mcs sub-device (MCSRaw). We need to ensure that
-        the MCSRaw device has all signals defined for which we want to push the values.
+        It is important that mux_output is set to the correct number of channels in on_connected,
+        because the callback here waits for updates on all channels before pushing data to BEC.
 
-        As we may receive multiple readings per point, e.g. if frames_per_trigger > 1,
-        we also create a mean value for the counter signals. These are then pushed to the bpm device
-        for plotting and further processing. The signal names are defined and mapped in the
-        self.counter_mapping dictionary & the bpm sub-device.
+        The _rlock is used to ensure thread safety as multiple callbacks may be executed
+        simultaneously from different threads.
 
-        There are multiple mca channels, each giving individual updates. We want to ensure that
-        each is updated before we signal that we are ready to read. In future, these signals may
-        become asynchronous, but we first need to ensure that we can properly combine monitored
-        signals with async signals for plotting. Until then, we will keep this logic.
+        If _omit_mca_callbacks is set, the callback will return immediately without processing the
+        data. This is used when erasing all channels to avoid interference with ongoing acquisition.
+        It has to manually cleared after the context manager 'suppress_mca_callbacks' is used.
+
+        Args:
+            value: The new value from the counter PV.
+            **kwargs: Additional keyword arguments from the subscription, including 'obj' (the EpicsSignalRO instance).
         """
         with self._rlock:
-            # Retrieve the signal object which executes this callback
-            signal = kwargs.get("obj", None)
-            if signal is None:  # This should never happen, but just in case
-                logger.info(f"Called without 'obj' in kwargs: {kwargs}")
+            if self._omit_mca_callbacks.is_set():
+                return  # Suppress callbacks when erasing all channels
+            self._mca_counter_index += 1
+            signal: EpicsSignalRO | None = kwargs.get("obj", None)
+            if signal is None:
+                logger.error(f"Called without 'obj' in kwargs: {kwargs}")
                 return
-            # Get the maped signal name from the mapping dictionary
-            mapped_signal_name = self.counter_mapping.get(signal.name, None)
-            # If we did not map the signal name in counter_mapping, but receive an update
-            # we will skip it.
-            if mapped_signal_name is None:
+
+            # NOTE: This relies on the naming convention of the mca channels being 'mca1', 'mca2', ..., 'mca32'.
+            # for the MCSCard class with the 'counters' DynamicDeviceComponent.
+            # Ignore any updates from channels beyond NUM_MCA_CHANNELS
+            attr_name = signal.attr_name
+            index = int(attr_name[3:])  # Extract index from 'mcaX'
+            if index > self.NUM_MCA_CHANNELS:
                 return
-            # Push the raw values of the mca channels. The signal name has to be defined
-            # in the self.mcs sub-device (MCSRaw) to be able to push the values. Otherwise
-            # we will skip the update.
-            mca_raw = getattr(self.mcs, signal.name.split("_")[-1], None)
-            if mca_raw is None:
-                return
-            # In case there was more than one value received, i.e. frames_per_trigger > 1,
-            # we will receive a np.array of values.
+
+            # NOTE Depending on the scan parameters, we may either receive single values or numpy arrays.
+            # Therefore, we need to handle both cases here to ensure that data is always stored. We do
+            # this by converting single values to a list with one element, and numpy arrays to lists.
             if isinstance(value, np.ndarray):
-                # We push the raw values as a list to the mca_raw signal
-                # And otherwise compute the mean value for plotting of counter signals
-                mca_raw.put(value.tolist())
-                # compute the count_time in seconds
-                if mapped_signal_name == "count_time":
-                    value = value / self._mcs_clock
-                value = float(value.mean())
+                value = value.tolist()  # Convert numpy array to list
             else:
-                # We received a single value, so we can directly push it
-                mca_raw.put(value)
-                # compute the count_time in seconds
-                if mapped_signal_name == "count_time":
-                    value = value / self._mcs_clock
+                value = [value]  # Received single value, convert to list
 
-            # Get the mapped signal from the bpm device and update it
-            sig = getattr(self.bpm, mapped_signal_name)
-            sig.put(value)
-            self.counter_updated.append(signal.name)
-            # Once all mca channels have been updated, we can signal that we are ready to read
-            received_all_updates = set(self.counter_updated) == set(self.counter_mapping.keys())
-            if received_all_updates:
-                self.ready_to_read.put(READYTOREAD.DONE)
-                # The reset of the signal is done in the on_trigger method of ddg1 for the next trigger
-                self.counter_updated.clear()  # Clear the list for the next update cycle
+            # Store the value with timestamp. If available in kwargs, use provided timestamp from CA,
+            # otherwise use current time when received.
+            self._current_data.update(
+                {attr_name: {"value": value, "timestamp": kwargs.get("timestamp") or time.time()}}
+            )
 
-    def _progress_update(self, value, **kwargs) -> None:
-        """Callback for progress updates from ophyd subscription on current_channel."""
-        # This logic needs to be further refined as this is currently reporting the progress
-        # of a single trigger from BEC within a burst scan.
-        frames_per_trigger = self.scan_info.msg.scan_parameters.get("frames_per_trigger", 1)
-        self.progress.put(
-            value=value, max_value=frames_per_trigger, done=bool(value == frames_per_trigger)
-        )
+            # Once we have received all channels, push data to BEC and reset for next accumulation
+            logger.debug(
+                f"Received update for {attr_name}, index {self._mca_counter_index}/{self.NUM_MCA_CHANNELS}"
+            )
+            if len(self._current_data) == self.NUM_MCA_CHANNELS:
+                logger.debug(
+                    f"Current data index {self._current_data_index} complete, pushing to BEC."
+                )
+                self.mca.put(self._current_data, acquisition_group=self._acquisition_group)
+                self._current_data.clear()
+                self._mca_counter_index = 0
+                self._current_data_index += 1
+
+    # NOTE The logic for the device progress is not yet fully refined for all scan types.
+    # This has to be adjusted once fly scan and step scan logic is fully implemented.
+    # pylint: disable=unused-argument
+    def _progress_update(self, *args, old_value: any, value: any, **kwargs) -> None:
+        """
+        Callback to update the progress signals base on values of current_channel in respect to expected total triggers.
+        Logic for these updates need to be extended once fly and step scan logic is fully implemented.
+
+        Args:
+            old_value: Previous value of the signal.
+            value: New value of the signal.
+        """
+        scan_done = bool(value == self._num_total_triggers)
+        self.progress.put(value=value, max_value=self._num_total_triggers, done=scan_done)
+        if scan_done:
+            self._scan_done_event.set()
 
     def on_stage(self) -> None:
         """
-        Called when the device is staged.
+        This method is called when the device is staged before a scan. Any bootstrapping required
+        for the scan should be handled here. We also need to handle MCS card specific logic to ensure
+        that the card is properly prepared for the scan.
+
+        The following procedure is implemented here:
+        - Ensure that any ongoing acquisition is stopped (should never happen if not interfered with manually)
+        - Erase all data on the MCS card to ensure a clean start (should never
+        - Set acquisition parameters based on scan parameters (frames_per_trigger, num_points, acquisition_group)
+        - Clear any events and buffers related to async data emission. This includes '_omit_mca_callbacks',
+            '_start_monitor_async_data_emission', '_scan_done_callbacks', and '_current_data'.
         """
-        self.erase_all.set(1).wait(timeout=self._pv_timeout)
+        start_time = time.time()
+
+        # NOTE: If for some reason, the card is still acquiring, we need to stop it first
+        # This should never happen as the card is properly stopped during unstage
+        # Can only happen if user manually interferes with the IOC through other means
+        if self.acquiring.get() == ACQUIRING.ACQUIRING:
+            logger.warning(
+                f"MCS Card {self.name} was still acquiring on staging. Stopping acquisition."
+            )
+            self.stop_all.put(1)
+            status = CompareStatus(self.acquiring, ACQUIRING.DONE)
+            status.wait(timeout=10)
+
+        # NOTE: If current_channel != 0, erase all data on the card. This
+        # needs to be done with the 'suppress_mca_callbacks' context manager as erase_all will result
+        # in data emission through mca callback subscriptions.
+        # The buffer needs to be cleared as this will otherwise lead to missing
+        # triggers during the scan. Again, this should not happen if unstage is properly called.
+        # But user interference or a restart of the device_server may lead to this situation.
+        if self.current_channel.get() != 0:
+            with suppress_mca_callbacks(self, restore_after_timeout=1.0):
+                logger.warning(
+                    f"MCS Card {self.name} had still data in buffer Erased all data on staging and sleeping for 1 second."
+                )
+                # Erase all data on the MCS card
+                self.erase_all.put(1)
+
+        #####################################
+        ### Setup Acquisition Parameters ###
+        #####################################
         triggers = self.scan_info.msg.scan_parameters.get("frames_per_trigger", 1)
+        num_points = self.scan_info.msg.num_points
+        self._num_total_triggers = triggers * num_points
+        self._acquisition_group = "monitored" if triggers == 1 else "burst_group"
         self.preset_real.set(0).wait(timeout=self._pv_timeout)
         self.num_use_all.set(triggers).wait(timeout=self._pv_timeout)
 
+        # Clear any previous data, just to be sure
+        with self._rlock:
+            self._current_data.clear()
+            self._mca_counter_index = 0
+
+        # NOTE Reset events for monitoring async_data_emission thread which is
+        # running during complete to wait for all data from the card
+        # to be emitted to BEC.
+        self._start_monitor_async_data_emission.clear()
+
+        # Clear any previous scan done callbacks
+        self._scan_done_callbacks.clear()
+
+        # Reset counter for data index of emitted data, NOTE for fly scans, this logic may have to be adjusted.
+        self._current_data_index = 0
+
+        # NOTE Make sure that the signal that omits mca callbacks is cleared
+        self._omit_mca_callbacks.clear()
+
+        logger.info(f"MCS Card {self.name} on_stage completed in {time.time() - start_time:.3f}s.")
+
     def on_unstage(self) -> None:
         """
-        Called when the device is unstaged.
+        Called when the device is unstaged. This method should be omnipotent and resolve fast.
+        It stops any ongoing acquisition, erases all data on the MCS and clears the local buffer '_current_data'.
+
+        NOTE: It is important that the logic for on_complete is solid and properly waiting for mca data to be emitted
+        to BEC. Otherwise, unstage may interfere with ongoing data emission. Unstage is called after complete during scans.
+        It is crucial that the device itself calls '_omit_mca_callbacks' in its on_stage method to make sure
+        that data is emitted once the card is properly staged.
         """
         self.stop_all.put(1)
-        self.ready_to_read.put(READYTOREAD.DONE)
-        # TODO why 0?
-        self.erase_all.set(0).wait(timeout=self._pv_timeout)
+        with suppress_mca_callbacks(self):
+            with self._rlock:
+                self._current_data.clear()
+                self._current_data_index = 0
+            self.erase_all.put(1)
 
-    def on_trigger(self) -> None:
-        status = TransitionStatus(
-            self.ready_to_read, strict=True, transitions=[READYTOREAD.PROCESSING, READYTOREAD.DONE]
-        )
-        self.cancel_on_stop(status)
-        return status
+    def _monitor_async_data_emission(self) -> None:
+        """
+        Monitoring loop that runs in a separate thread to check if all async data has been emitted to BEC.
+        It is IDLE most of the time, but activate in the 'on_complete' method called by 'complete'.
 
-    def on_pre_scan(self) -> None:
-        """
-        Called before the scan starts.
+        The check is done by comparing the number of data updates '_current_data_index' received through
+        mca channel callbacks with the expected number of points in the scan. Once they match, all
+        callbacks in _scan_done_callbacks are called to indicate that data emission is done.
+        Callbacks need to also accept and handle exceptions to properly report failure.
+        NOTE! This logic currently works for any step scan, but has to be extended for fly scans.
         """
+        while not self._scan_done_thread_kill_event.is_set():
+            while self._start_monitor_async_data_emission.wait():
+                try:
+                    logger.debug(f"Monitoring async data emission for {self.name}...")
+                    if (
+                        hasattr(self.scan_info.msg, "num_points")
+                        and self.scan_info.msg.num_points is not None
+                    ):
+                        if self._current_data_index == self.scan_info.msg.num_points:
+                            for callback in self._scan_done_callbacks:
+                                callback(exception=None)
+                    time.sleep(0.02)  # 20ms delay to avoid busy loop
+                except Exception as exc:  # pylint: disable=broad-except
+                    content = traceback.format_exc()
+                    logger.error(
+                        f"Exception in monitoring thread of complete for {self.name}:\n{content}"
+                        "Running callbacks to avoid deadlock."
+                    )
+                    for callback in self._scan_done_callbacks:
+                        callback(exception=exc)
+
+    def _status_callback(self, status: StatusBase, exception=None) -> None:
+        """Callback for status completion."""
+        self._start_monitor_async_data_emission.clear()  # Stop monitoring
+        # NOTE Important check as set_finished or set_exception should not be called
+        # if the status is already done (e.g. cancelled externally)
+        with self._rlock:
+            if status.done:
+                return  # Already done and cancelled externally.
+            if exception is not None:
+                status.set_exception(exception)
+            else:
+                status.set_finished()
+
+    def _status_failed_callback(self, status: StatusBase) -> None:
+        """Callback for status failure, the monitoring thread should be stopped."""
+        # NOTE Check for status.done and status.success is important to avoid
+        if status.done:
+
+            self._start_monitor_async_data_emission.clear()  # Stop monitoring
 
     def on_complete(self) -> CompareStatus:
-        """On scan completion."""
-        # Check if we should get a signal based on updates from the MCA channels
+        """
+
+        Method that is called at the end of scan core, but before unstage. This method is
+        used to report whether the device successfully completed its data acquisition for the scan.
+        The check has to be implemented asynchronously and resolve through a status (future) object
+        returned by this method.
+        NOTE: For the MCS card, we need to ensure that all data has been acquired
+        and emitted to BEC as updates after 'on_complete' resolved will be rejected by BEC.
+        Therefore, we need to ensure that all data has been emitted to BEC before
+        reporting completion of the device.
+
+        This method implements the following procedure:
+        - Starts the IDLE async data monitoring thread that checks if all expected data
+            has been emitted to BEC through the mca channel callbacks.
+        - Use a CompareStatus to monitor when the MCS card becomes DONE. Please note that this
+            only indicates that the card has finished acquisition, but not that all data has been
+            emitted to BEC.
+        - Return combined status object. A callback is registered to handle failure of the status
+            if it is stopped externally, e.g. through scan abort. This should ensure that the
+            monitoring thread is stopped properly.
+
+        """
+        # Prepare and register status callback for the async monitoring loop
+        status_async_data = StatusBase(obj=self)
+        self._scan_done_callbacks.append(partial(self._status_callback, status_async_data))
+
+        # Set the event to start monitoring async data emission
+        logger.debug(f"Starting to monitor async data emission for {self.name}...")
+        self._start_monitor_async_data_emission.set()
+
+        # Add CompareStatus for Acquiring DONE
         status = CompareStatus(self.acquiring, ACQUIRING.DONE)
-        self.cancel_on_stop(status)
-        return status
+
+        # Combine both statuses
+        ret_status = status & status_async_data
+        # Handle external stop/cancel, and stop monitoring
+        ret_status.add_callback(self._status_failed_callback)
+        self.cancel_on_stop(ret_status)
+        return ret_status
+
+    def on_destroy(self):
+        """
+        The on destroy hook is called when the device is destroyed, but also reloaded.
+        Here, we need to clean up all resources used up by the device, including running threads.
+        """
+        self._scan_done_thread_kill_event.set()
+        self._start_monitor_async_data_emission.set()
+        if self._scan_done_thread.is_alive():
+            self._scan_done_thread.join(timeout=2.0)
+            if self._scan_done_thread.is_alive():
+                logger.warning(f"Thread for device {self.name} did not terminate properly.")
 
     def on_stop(self) -> None:
-        """
-        Called when the scan is stopped.
-        """
+        """Hook called when the device is stopped. In addition, any status that is registered through cancel_on_stop will be cancelled here."""
         self.stop_all.put(1)
-        self.ready_to_read.put(READYTOREAD.DONE)
-        # Reset the progress signal
-        # self.progress.put(0, done=True)
+        self.erase_all.put(1)
+
+    def mcs_recovery(self, timeout: int = 1) -> None:
+        """
+        Recovery procedure for the mcs card. This procedure has been empirically found and can
+        be used to ensure that the MCS card is stopped and has no pending data to be emitted.
+        It involves stopping any ongoing acquisition and erasing all data on the card, with
+        a sleep in between to allow the IOC to process the commands.
+
+        Args:
+            timeout (int): Total timeout for the recovery procedure. Defaults to 1 second.
+        """
+        sleep_time = timeout / 2  # 2 sleeps
+        logger.debug(
+            f"Running recovery procedure for MCS card {self.name} with {sleep_time}s sleep, calling stop_all and erase_all, and another {sleep_time}s sleep"
+        )
+        # First erase and start ongoing acquisition.
+        self.erase_start.put(1)
+        time.sleep(sleep_time)
+        # After a brief processing time, we stop any ongoing acquisition.
+        self.stop_all.put(1)
+        # Finally, we erase all data while suppressing mca callbacks to avoid interference.
+        # We restore the callback suppression after timeout to ensure proper operation afterwards.
+        with suppress_mca_callbacks(self, restore_after_timeout=sleep_time):
+            self.erase_all.put(1)

csaxs_bec/devices/epics/pilatus_csaxs.py

@@ -1,400 +0,0 @@
-import enum
-import json
-import os
-import threading
-import time
-
-import numpy as np
-import requests
-from bec_lib import bec_logger
-from ophyd import ADComponent as ADCpt
-from ophyd import Device, EpicsSignal, EpicsSignalRO, EpicsSignalWithRBV, Staged
-from ophyd_devices.interfaces.base_classes.psi_detector_base import (
-    CustomDetectorMixin,
-    PSIDetectorBase,
-)
-
-logger = bec_logger.logger
-
-
-class PilatusError(Exception):
-    """Base class for exceptions in this module."""
-
-
-class PilatusTimeoutError(PilatusError):
-    """Raised when the Pilatus does not respond in time during unstage."""
-
-
-class TriggerSource(enum.IntEnum):
-    """Trigger source options for the detector"""
-
-    INTERNAL = 0
-    EXT_ENABLE = 1
-    EXT_TRIGGER = 2
-    MULTI_TRIGGER = 3
-    ALGINMENT = 4
-
-
-class SLSDetectorCam(Device):
-    """SLS Detector Camera - Pilatus
-
-    Base class to map EPICS PVs to ophyd signals.
-    """
-
-    num_images = ADCpt(EpicsSignalWithRBV, "NumImages")
-    num_frames = ADCpt(EpicsSignalWithRBV, "NumExposures")
-    delay_time = ADCpt(EpicsSignalWithRBV, "NumExposures")
-    trigger_mode = ADCpt(EpicsSignalWithRBV, "TriggerMode")
-    acquire = ADCpt(EpicsSignal, "Acquire")
-    armed = ADCpt(EpicsSignalRO, "Armed")
-
-    read_file_timeout = ADCpt(EpicsSignal, "ImageFileTmot")
-    detector_state = ADCpt(EpicsSignalRO, "StatusMessage_RBV")
-    status_message_camserver = ADCpt(EpicsSignalRO, "StringFromServer_RBV", string=True)
-    acquire_time = ADCpt(EpicsSignal, "AcquireTime")
-    acquire_period = ADCpt(EpicsSignal, "AcquirePeriod")
-    threshold_energy = ADCpt(EpicsSignalWithRBV, "ThresholdEnergy")
-    file_path = ADCpt(EpicsSignalWithRBV, "FilePath")
-    file_name = ADCpt(EpicsSignalWithRBV, "FileName")
-    file_number = ADCpt(EpicsSignalWithRBV, "FileNumber")
-    auto_increment = ADCpt(EpicsSignalWithRBV, "AutoIncrement")
-    file_template = ADCpt(EpicsSignalWithRBV, "FileTemplate")
-    file_format = ADCpt(EpicsSignalWithRBV, "FileNumber")
-    gap_fill = ADCpt(EpicsSignalWithRBV, "GapFill")
-
-
-class PilatusSetup(CustomDetectorMixin):
-    """Pilatus setup class for cSAXS
-
-    Parent class: CustomDetectorMixin
-
-    """
-
-    def __init__(self, *args, parent: Device = None, **kwargs) -> None:
-        super().__init__(*args, parent=parent, **kwargs)
-        self._lock = threading.RLock()
-
-    def on_init(self) -> None:
-        """Initialize the detector"""
-        self.initialize_default_parameter()
-        self.initialize_detector()
-
-    def initialize_default_parameter(self) -> None:
-        """Set default parameters for Eiger9M detector"""
-        self.update_readout_time()
-
-    def update_readout_time(self) -> None:
-        """Set readout time for Eiger9M detector"""
-        readout_time = (
-            self.parent.scaninfo.readout_time
-            if hasattr(self.parent.scaninfo, "readout_time")
-            else self.parent.MIN_READOUT
-        )
-        self.parent.readout_time = max(readout_time, self.parent.MIN_READOUT)
-
-    def initialize_detector(self) -> None:
-        """Initialize detector"""
-        # Stops the detector
-        self.stop_detector()
-        # Sets the trigger source to GATING
-        self.parent.cam.trigger_mode.put(TriggerSource.EXT_ENABLE)
-
-    def on_stage(self) -> None:
-        """Stage the detector for scan"""
-        self.prepare_detector()
-        self.prepare_data_backend()
-        self.publish_file_location(
-            done=False, successful=False, metadata={"input_path": self.parent.filepath_raw}
-        )
-
-    def prepare_detector(self) -> None:
-        """
-        Prepare detector for scan.
-
-        Includes checking the detector threshold,
-        setting the acquisition parameters and setting the trigger source
-        """
-        self.set_detector_threshold()
-        self.set_acquisition_params()
-        self.parent.cam.trigger_mode.put(TriggerSource.EXT_ENABLE)
-
-    def prepare_data_backend(self) -> None:
-        """
-        Prepare the detector backend of pilatus for a scan
-
-        A zmq service is running on xbl-daq-34 that is waiting
-        for a zmq message to start the writer for the pilatus_2 x12sa-pd-2
-
-        """
-
-        self.stop_detector_backend()
-
-        self.parent.filepath.set(
-            self.parent.filewriter.compile_full_filename("pilatus_2.h5")
-        ).wait()
-        self.parent.cam.file_path.put("/dev/shm/zmq/")
-        self.parent.cam.file_name.put(
-            f"{self.parent.scaninfo.username}_2_{self.parent.scaninfo.scan_number:05d}"
-        )
-        self.parent.cam.auto_increment.put(1)  # auto increment
-        self.parent.cam.file_number.put(0)  # first iter
-        self.parent.cam.file_format.put(0)  # 0: TIFF
-        self.parent.cam.file_template.put("%s%s_%5.5d.cbf")
-
-        # TODO better to remove hard coded path with link to home directory/pilatus_2
-        basepath = f"/sls/X12SA/data/{self.parent.scaninfo.username}/Data10/pilatus_2/"
-        self.parent.filepath_raw = os.path.join(
-            basepath,
-            self.parent.filewriter.get_scan_directory(self.parent.scaninfo.scan_number, 1000, 5),
-        )
-        # Make directory if needed
-        self.create_directory(self.parent.filepath_raw)
-
-        headers = {"Content-Type": "application/json", "Accept": "application/json"}
-        # start the stream on x12sa-pd-2
-        url = "http://x12sa-pd-2:8080/stream/pilatus_2"
-        data_msg = {
-            "source": [
-                {
-                    "searchPath": "/",
-                    "searchPattern": "glob:*.cbf",
-                    "destinationPath": self.parent.filepath_raw,
-                }
-            ]
-        }
-        res = self.send_requests_put(url=url, data=data_msg, headers=headers)
-        logger.info(f"{res.status_code} -  {res.text} - {res.content}")
-
-        if not res.ok:
-            res.raise_for_status()
-
-        # start the data receiver on xbl-daq-34
-        url = "http://xbl-daq-34:8091/pilatus_2/run"
-        data_msg = [
-            "zmqWriter",
-            self.parent.scaninfo.username,
-            {
-                "addr": "tcp://x12sa-pd-2:8888",
-                "dst": ["file"],
-                "numFrm": int(
-                    self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger
-                ),
-                "timeout": 2000,
-                "ifType": "PULL",
-                "user": self.parent.scaninfo.username,
-            },
-        ]
-        res = self.send_requests_put(url=url, data=data_msg, headers=headers)
-        logger.info(f"{res.status_code}  - {res.text} - {res.content}")
-
-        if not res.ok:
-            res.raise_for_status()
-
-        # Wait for server to become available again
-        time.sleep(0.1)
-        logger.info(f"{res.status_code} -{res.text} - {res.content}")
-
-        # Send requests.put to xbl-daq-34 to wait for data
-        url = "http://xbl-daq-34:8091/pilatus_2/wait"
-        data_msg = [
-            "zmqWriter",
-            self.parent.scaninfo.username,
-            {
-                "frmCnt": int(
-                    self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger
-                ),
-                "timeout": 2000,
-            },
-        ]
-        try:
-            res = self.send_requests_put(url=url, data=data_msg, headers=headers)
-            logger.info(f"{res}")
-
-            if not res.ok:
-                res.raise_for_status()
-        except Exception as exc:
-            logger.info(f"Pilatus2 wait threw Exception: {exc}")
-
-    def set_detector_threshold(self) -> None:
-        """
-        Set correct detector threshold to 1/2 of current X-ray energy, allow 5% tolerance
-
-        Threshold might be in ev or keV
-        """
-
-        # get current beam energy from device manageer
-        mokev = self.parent.device_manager.devices.mokev.obj.read()[
-            self.parent.device_manager.devices.mokev.name
-        ]["value"]
-        factor = 1
-
-        # Check if energies are eV or keV, assume keV as the default
-        unit = getattr(self.parent.cam.threshold_energy, "units", None)
-        if unit is not None and unit == "eV":
-            factor = 1000
-
-        # set energy on detector
-        setpoint = int(mokev * factor)
-
-        # set threshold on detector
-        threshold = self.parent.cam.threshold_energy.read()[self.parent.cam.threshold_energy.name][
-            "value"
-        ]
-        if not np.isclose(setpoint / 2, threshold, rtol=0.05):
-            self.parent.cam.threshold_energy.set(setpoint / 2)
-
-    def set_acquisition_params(self) -> None:
-        """Set acquisition parameters for the detector"""
-
-        # Set number of images and frames (frames is for internal burst of detector)
-        self.parent.cam.num_images.put(
-            int(self.parent.scaninfo.num_points * self.parent.scaninfo.frames_per_trigger)
-        )
-        self.parent.cam.num_frames.put(1)
-
-        # Update the readout time of the detector
-        self.update_readout_time()
-
-    def create_directory(self, filepath: str) -> None:
-        """Create directory if it does not exist"""
-        os.makedirs(filepath, exist_ok=True)
-
-    def close_file_writer(self) -> None:
-        """
-        Close the file writer for pilatus_2
-
-        Delete the data from x12sa-pd-2
-
-        """
-        url = "http://x12sa-pd-2:8080/stream/pilatus_2"
-        try:
-            res = self.send_requests_delete(url=url)
-            if not res.ok:
-                res.raise_for_status()
-        except Exception as exc:
-            logger.info(f"Pilatus2 close threw Exception: {exc}")
-
-    def stop_file_writer(self) -> None:
-        """
-        Stop the file writer for pilatus_2
-
-        Runs on xbl-daq-34
-        """
-        url = "http://xbl-daq-34:8091/pilatus_2/stop"
-        res = self.send_requests_put(url=url)
-        if not res.ok:
-            res.raise_for_status()
-
-    def send_requests_put(self, url: str, data: list = None, headers: dict = None) -> object:
-        """
-        Send a put request to the given url
-
-        Args:
-            url (str): url to send the request to
-            data (dict): data to be sent with the request (optional)
-            headers (dict): headers to be sent with the request (optional)
-
-        Returns:
-            status code of the request
-        """
-        return requests.put(url=url, data=json.dumps(data), headers=headers, timeout=5)
-
-    def send_requests_delete(self, url: str, headers: dict = None) -> object:
-        """
-        Send a delete request to the given url
-
-        Args:
-            url (str): url to send the request to
-            headers (dict): headers to be sent with the request (optional)
-
-        Returns:
-            status code of the request
-        """
-        return requests.delete(url=url, headers=headers, timeout=5)
-
-    def on_pre_scan(self) -> None:
-        """Prepare detector for scan"""
-        self.arm_acquisition()
-
-    def arm_acquisition(self) -> None:
-        """Arms the detector for the acquisition"""
-        self.parent.cam.acquire.put(1)
-        # TODO is this sleep needed? to be tested with detector and for how long
-        time.sleep(0.5)
-
-    def on_unstage(self) -> None:
-        """Unstage the detector"""
-        pass
-
-    def on_complete(self) -> None:
-        """Complete the scan"""
-        self.finished(timeout=self.parent.TIMEOUT_FOR_SIGNALS)
-        self.publish_file_location(
-            done=True, successful=True, metadata={"input_path": self.parent.filepath_raw}
-        )
-
-    def finished(self, timeout: int = 5) -> None:
-        """Check if acquisition is finished."""
-        # pylint: disable=protected-access
-        # TODO: at the moment this relies on device.mcs.obj._staged attribute
-        signal_conditions = [
-            (lambda: self.parent.device_manager.devices.mcs.obj._staged, Staged.no)
-        ]
-        if not self.wait_for_signals(
-            signal_conditions=signal_conditions,
-            timeout=timeout,
-            check_stopped=True,
-            all_signals=True,
-        ):
-            raise PilatusTimeoutError(
-                f"Reached timeout with detector state {signal_conditions[0][0]}, std_daq state"
-                f" {signal_conditions[1][0]} and received frames of {signal_conditions[2][0]} for"
-                " the file writer"
-            )
-        self.stop_detector()
-        self.stop_detector_backend()
-
-    def on_stop(self) -> None:
-        """Stop detector"""
-        self.stop_detector()
-        self.stop_detector_backend()
-
-    def stop_detector(self) -> None:
-        """Stop detector"""
-        self.parent.cam.acquire.put(0)
-
-    def stop_detector_backend(self) -> None:
-        """Stop the file writer zmq service for pilatus_2"""
-        self.close_file_writer()
-        time.sleep(0.1)
-        self.stop_file_writer()
-        time.sleep(0.1)
-
-
-class PilatuscSAXS(PSIDetectorBase):
-    """Pilatus_2 300k detector for CSAXS
-
-    Parent class: PSIDetectorBase
-
-    class attributes:
-        custom_prepare_cls (Eiger9MSetup)   : Custom detector setup class for cSAXS,
-                                              inherits from CustomDetectorMixin
-        cam (SLSDetectorCam)                : Detector camera
-        MIN_READOUT (float)                 : Minimum readout time for the detector
-
-    """
-
-    # Specify which functions are revealed to the user in BEC client
-    USER_ACCESS = []
-
-    # specify Setup class
-    custom_prepare_cls = PilatusSetup
-    # specify minimum readout time for detector
-    MIN_READOUT = 3e-3
-    TIMEOUT_FOR_SIGNALS = 5
-    # specify class attributes
-    cam = ADCpt(SLSDetectorCam, "cam1:")
-
-
-if __name__ == "__main__":
-    pilatus_2 = PilatuscSAXS(name="pilatus_2", prefix="X12SA-ES-PILATUS300K:", sim_mode=True)

csaxs_bec/devices/ids_cameras/base_integration/camera.py

@@ -15,10 +15,10 @@ CI/CD pipelines can run without the pyueye library or the related DLLs installed
 from __future__ import annotations
 
 import atexit
+import time
 from typing import Literal
 
 import numpy as np
-import time
 from bec_lib.logger import bec_logger
 
 from csaxs_bec.devices.ids_cameras.base_integration.utils import check_error
@@ -67,8 +67,8 @@ class IDSCameraObject:
         check_error(ueye.is_SetDisplayMode(self.h_cam, ueye.IS_SET_DM_DIB), "IDSCameraObject")
 
         if (
-                int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
-                == self.ueye.IS_COLORMODE_BAYER
+            int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
+            == self.ueye.IS_COLORMODE_BAYER
         ):
             logger.info("Bayer color mode detected.")
             # setup the color depth to the current windows setting
@@ -77,16 +77,16 @@ class IDSCameraObject:
             )  # TODO This raises an error - maybe check the m_n_colormode value
             self.bytes_per_pixel = int(self.n_bits_per_pixel / 8)
         elif (
-                int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
-                == self.ueye.IS_COLORMODE_CBYCRY
+            int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
+            == self.ueye.IS_COLORMODE_CBYCRY
         ):
             # for color camera models use RGB32 mode
             self.m_n_colormode = self.ueye.IS_CM_BGRA8_PACKED
             self.n_bits_per_pixel = self.ueye.INT(32)
             self.bytes_per_pixel = int(self.n_bits_per_pixel / 8)
         elif (
-                int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
-                == self.ueye.IS_COLORMODE_MONOCHROME
+            int.from_bytes(self.s_info.nColorMode.value, byteorder="big")
+            == self.ueye.IS_COLORMODE_MONOCHROME
         ):
             # for color camera models use RGB32 mode
             self.m_n_colormode = self.ueye.IS_CM_MONO8
@@ -160,12 +160,12 @@ class Camera:
     """
 
     def __init__(
-            self,
-            camera_id: int,
-            m_n_colormode: Literal[0, 1, 2, 3] = 1,
-            bits_per_pixel: int = 24,
-            connect: bool = True,
-            force_monochrome: bool = False,
+        self,
+        camera_id: int,
+        m_n_colormode: Literal[0, 1, 2, 3] = 1,
+        bits_per_pixel: int = 24,
+        connect: bool = True,
+        force_monochrome: bool = False,
     ):
         self.ueye = ueye
         self.camera_id = camera_id
@@ -173,8 +173,13 @@ class Camera:
         self.force_monochrome = force_monochrome
         self._connected = False
         self.cam = None
+
         atexit.register(self.on_disconnect)
 
+        self._enable_warning_rate_limit: bool = False
+        self._last_rate_limited_log: float = 0
+        self._warning_log_rate_limit_s: float = 10
+
         if connect:
             self.on_connect()
 
@@ -255,7 +260,7 @@ class Camera:
     def get_image_data(self) -> np.ndarray | None:
         """Get the image data from the camera."""
         if not self._connected:
-            logger.warning("Camera is not connected.")
+            self._rate_limited_warning_log("Camera is not connected.")
             return None
         array = self.ueye.get_data(
             self.cam.pc_image_mem,
@@ -282,6 +287,22 @@ class Camera:
 
         return img
 
+    def set_camera_rate_limiting(self, enabled: bool, rate_limit_s: float | None = None):
+        if rate_limit_s is not None:
+            if rate_limit_s <= 0:
+                raise ValueError(f"Invalid rate limit: {rate_limit_s}, must be positive nonzero.")
+            self._warning_log_rate_limit_s = rate_limit_s
+        self._enable_warning_rate_limit = enabled
+
+    def _rate_limited_warning_log(self, msg: "str"):
+        if (
+            self._enable_warning_rate_limit
+            and time.monotonic() < self._last_rate_limited_log + self._warning_log_rate_limit_s
+        ):
+            return
+        self._last_rate_limited_log = time.monotonic()
+        logger.warning(msg)
+
 
 if __name__ == "__main__":
     # Example usage

csaxs_bec/devices/ids_cameras/ids_camera.py

@@ -29,8 +29,14 @@ class IDSCamera(PSIDeviceBase):
     to interact with the IDS camera using the pyueye library.
     """
 
-    image = Cpt(PreviewSignal, name="image", ndim=2, doc="Preview signal for the camera.", num_rotation_90=0,
-                transpose=False)
+    image = Cpt(
+        PreviewSignal,
+        name="image",
+        ndim=2,
+        doc="Preview signal for the camera.",
+        num_rotation_90=0,
+        transpose=False,
+    )
     roi_signal = Cpt(
         AsyncSignal,
         name="roi_signal",
@@ -43,19 +49,19 @@ class IDSCamera(PSIDeviceBase):
     USER_ACCESS = ["live_mode", "mask", "set_rect_roi", "get_last_image"]
 
     def __init__(
-            self,
-            *,
-            name: str,
-            camera_id: int,
-            prefix: str = "",
-            scan_info: ScanInfo | None = None,
-            m_n_colormode: Literal[0, 1, 2, 3] = 1,
-            bits_per_pixel: Literal[8, 24] = 24,
-            live_mode: bool = False,
-            num_rotation_90: int = 0,
-            transpose: bool = False,
-            force_monochrome: bool = False,
-            **kwargs,
+        self,
+        *,
+        name: str,
+        camera_id: int,
+        prefix: str = "",
+        scan_info: ScanInfo | None = None,
+        m_n_colormode: Literal[0, 1, 2, 3] = 1,
+        bits_per_pixel: Literal[8, 24] = 24,
+        live_mode: bool = False,
+        num_rotation_90: int = 0,
+        transpose: bool = False,
+        force_monochrome: bool = False,
+        **kwargs,
     ):
         """Initialize the IDS Camera.
 
@@ -133,7 +139,7 @@ class IDSCamera(PSIDeviceBase):
         if x + width > img_shape[1] or y + height > img_shape[0]:
             raise ValueError("ROI exceeds camera dimensions.")
         mask = np.zeros(img_shape, dtype=np.uint8)
-        mask[y: y + height, x: x + width] = 1
+        mask[y : y + height, x : x + width] = 1
         self.mask = mask
 
     def _start_live(self):
@@ -162,6 +168,7 @@ class IDSCamera(PSIDeviceBase):
 
     def _live_mode_loop(self, stop_event: threading.Event):
         """Loop to capture images in live mode."""
+        self.cam.set_camera_rate_limiting(True)
         while not stop_event.is_set():
             try:
                 self.process_data(self.cam.get_image_data())
@@ -169,6 +176,7 @@ class IDSCamera(PSIDeviceBase):
                 logger.error(f"Error in live mode loop: {e}")
                 break
             stop_event.wait(0.2)  # 5 Hz
+        self.cam.set_camera_rate_limiting(False)
 
     def process_data(self, image: np.ndarray | None):
         """Process the image data before sending it to the preview signal."""

csaxs_bec/devices/npoint/npoint.py

@@ -442,6 +442,9 @@ class NPointAxis(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
+    def wait_for_connection(self, all_signals=False, timeout: float = 30.0) -> bool:
+        self.controller.on(timeout=timeout)
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

csaxs_bec/devices/omny/galil/fgalil_ophyd.py

@@ -212,8 +212,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/galil/fupr_ophyd.py

@@ -185,8 +185,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

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,8 +170,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/galil/ogalil_ophyd.py

@@ -324,8 +324,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/galil/sgalil_ophyd.py

@@ -530,8 +530,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/rt/rt_flomni_ophyd.py

@@ -678,8 +678,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/rt/rt_lamni_ophyd.py

@@ -588,8 +588,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/omny/rt/rt_omny_ophyd.py

@@ -1119,8 +1119,7 @@ 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, all_signals=False, timeout: float = 30.0) -> bool:
         self.controller.on(timeout=timeout)
 
     @property

csaxs_bec/devices/smaract/smaract_ophyd.py

@@ -153,6 +153,9 @@ class SmaractMotor(Device, PositionerBase):
             self.low_limit_travel.put(limits[0])
             self.high_limit_travel.put(limits[1])
 
+    def wait_for_connection(self, all_signals=False, timeout: float = 30.0) -> bool:
+        self.controller.on(timeout=timeout)
+
     @property
     def limits(self):
         return (self.low_limit_travel.get(), self.high_limit_travel.get())

tests/tests_devices/test_delay_generator_csaxs.py

@@ -6,9 +6,35 @@ from unittest import mock
 import numpy as np
 import ophyd
 import pytest
-from ophyd_devices.tests.utils import MockPV, patch_dual_pvs
+from bec_server.device_server.tests.utils import DMMock
+from ophyd_devices.tests.utils import patched_device
 
 from csaxs_bec.devices.epics.delay_generator_csaxs import DDG1, DDG2
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_1 import (
+    DEFAULT_IO_CONFIG as DDG1_DEFAULT_IO_CONFIG,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_1 import (
+    DEFAULT_READOUT_TIMES as DDG1_DEFAULT_READOUT_TIMES,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_1 import (
+    DEFAULT_REFERENCES as DDG1_DEFAULT_REFERENCES,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_1 import (
+    DEFAULT_TRIGGER_SOURCE as DDG1_DEFAULT_TRIGGER_SOURCE,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_1 import PROC_EVENT_MODE
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_2 import (
+    DEFAULT_IO_CONFIG as DDG2_DEFAULT_IO_CONFIG,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_2 import (
+    DEFAULT_READOUT_TIMES as DDG2_DEFAULT_READOUT_TIMES,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_2 import (
+    DEFAULT_REFERENCES as DDG2_DEFAULT_REFERENCES,
+)
+from csaxs_bec.devices.epics.delay_generator_csaxs.ddg_2 import (
+    DEFAULT_TRIGGER_SOURCE as DDG2_DEFAULT_TRIGGER_SOURCE,
+)
 from csaxs_bec.devices.epics.delay_generator_csaxs.delay_generator_csaxs import (
     BURSTCONFIG,
     CHANNELREFERENCE,
@@ -16,68 +42,46 @@ from csaxs_bec.devices.epics.delay_generator_csaxs.delay_generator_csaxs import
     TRIGGERSOURCE,
     DelayGeneratorCSAXS,
 )
+from csaxs_bec.devices.epics.mcs_card.mcs_card_csaxs import MCSCardCSAXS
 
-
-@pytest.fixture(scope="function")
-def mock_ddg1() -> Generator[DDG1, DDG1, DDG1]:
-    """Fixture to mock the DDG1 device."""
-    name = "ddg1"
-    prefix = "test_ddg1:"
-    with mock.patch.object(ophyd, "cl") as mock_cl:
-        mock_cl.get_pv = MockPV
-        mock_cl.thread_class = threading.Thread
-        dev = DDG1(name=name, prefix=prefix)
-        patch_dual_pvs(dev)
-        yield dev
-
-
-@pytest.fixture(scope="function")
-def mock_ddg2() -> Generator[DDG2, DDG2, DDG2]:
-    """Fixture to mock the DDG1 device."""
-    name = "ddg2"
-    prefix = "test_ddg2:"
-    with mock.patch.object(ophyd, "cl") as mock_cl:
-        mock_cl.get_pv = MockPV
-        mock_cl.thread_class = threading.Thread
-        dev = DDG2(name=name, prefix=prefix)
-        patch_dual_pvs(dev)
-        yield dev
+############################
+### Test Delay Generator ###
+############################
 
 
 @pytest.fixture(scope="function")
 def mock_ddg() -> Generator[DelayGeneratorCSAXS, DelayGeneratorCSAXS, DelayGeneratorCSAXS]:
     """Fixture to mock the camera device."""
-    name = "ddg"
-    prefix = "test:"
-    with mock.patch.object(ophyd, "cl") as mock_cl:
-        mock_cl.get_pv = MockPV
-        mock_cl.thread_class = threading.Thread
-        dev = DelayGeneratorCSAXS(name=name, prefix=prefix)
-        patch_dual_pvs(dev)
-        yield dev
+    with patched_device(
+        DelayGeneratorCSAXS, name="ddg", prefix="test:", _mock_pv_initial_value=0
+    ) as dev:
+        try:
+            yield dev
+        finally:
+            dev.destroy()
 
 
-def test_ddg_init(mock_ddg):
+def test_ddg_init(mock_ddg: DelayGeneratorCSAXS):
     """Test the proc event status method."""
     assert mock_ddg.name == "ddg"
     assert mock_ddg.prefix == "test:"
 
 
-def test_ddg_proc_event_status(mock_ddg):
+def test_ddg_proc_event_status(mock_ddg: DelayGeneratorCSAXS):
     """Test the proc event status method."""
     mock_ddg.state.proc_status.put(0)
     mock_ddg.proc_event_status()
     assert mock_ddg.state.proc_status.get() == 1
 
 
-def test_ddg_set_trigger(mock_ddg):
+def test_ddg_set_trigger(mock_ddg: DelayGeneratorCSAXS):
     """Test setting the trigger."""
     for trigger in TRIGGERSOURCE:
         mock_ddg.set_trigger(trigger)
         assert mock_ddg.trigger_source.get() == trigger.value
 
 
-def test_ddg_burst_enable(mock_ddg):
+def test_ddg_burst_enable(mock_ddg: DelayGeneratorCSAXS):
     """Test enabling burst mode."""
     mock_ddg.burst_enable(count=100, delay=0.1, period=0.02, config=BURSTCONFIG.ALL_CYCLES)
     mock_ddg.burst_mode.get() == 1
@@ -101,7 +105,7 @@ def test_ddg_burst_enable(mock_ddg):
     mock_ddg.burst_mode.get() == BURSTCONFIG.FIRST_CYCLE.value
 
 
-def test_ddg_wait_for_event_status(mock_ddg):
+def test_ddg_wait_for_event_status(mock_ddg: DelayGeneratorCSAXS):
     """Test setting wait for event status."""
     mock_ddg: DelayGeneratorCSAXS
     mock_ddg.state.event_status._read_pv.mock_data = 0
@@ -117,7 +121,7 @@ def test_ddg_wait_for_event_status(mock_ddg):
     # assert status.done is True
 
 
-def test_ddg_set_io_values(mock_ddg):
+def test_ddg_set_io_values(mock_ddg: DelayGeneratorCSAXS):
     """Test setting IO values."""
     mock_ddg.set_io_values(channel="ab", amplitude=3, offset=2, polarity=1, mode="ttl")
     assert mock_ddg.ab.io.amplitude.get() == 3
@@ -138,7 +142,7 @@ def test_ddg_set_io_values(mock_ddg):
         assert attr.nim_mode.get() == 1
 
 
-def test_ddg_set_delay_pairs(mock_ddg):
+def test_ddg_set_delay_pairs(mock_ddg: DelayGeneratorCSAXS):
     """Test setting delay pairs."""
     mock_ddg.set_delay_pairs(channel="ab", delay=0.1, width=0.2)
     assert np.isclose(mock_ddg.ab.delay.get(), 0.1)
@@ -156,52 +160,143 @@ def test_ddg_set_delay_pairs(mock_ddg):
         assert np.isclose(getattr(mock_ddg, channel).ch2.setpoint.get(), delay + 0.2)
 
 
-def test_ddg1_on_connected(mock_ddg1):
+#########################
+### Test DDG1 Device ####
+#########################
+
+
+@pytest.fixture(scope="function")
+def mock_mcs_csaxs() -> Generator[MCSCardCSAXS, None, None]:
+    """Fixture to mock the MCSCardCSAXS device."""
+    dm = DMMock()
+    with patched_device(
+        MCSCardCSAXS,
+        name="mcs",
+        prefix="X12SA-MCS-CSAXS:",
+        device_manager=dm,
+        _mock_pv_initial_value=0,
+    ) as dev:
+        dev.enabled = True
+        dev.device_manager.devices["mcs"] = dev
+        try:
+            yield dev
+        finally:
+            dev.destroy()
+
+
+@pytest.fixture(scope="function")
+def mock_ddg1(mock_mcs_csaxs: MCSCardCSAXS) -> Generator[DDG1, None, None]:
+    """Fixture to mock the DDG1 device."""
+    # Add enabled to mock_mcs_csaxs
+    dm_mock = mock_mcs_csaxs.device_manager
+    with patched_device(
+        DDG1, name="ddg1", prefix="test_ddg1:", device_manager=dm_mock, _mock_pv_initial_value=0
+    ) as dev:
+        dev.enabled = True
+        dev.device_manager.devices["ddg1"] = dev
+        try:
+            yield dev
+        finally:
+            dev.destroy()
+
+
+def test_ddg1_on_connected(mock_ddg1: DDG1):
     """Test the on_connected method of DDG1."""
-    mock_ddg1.on_connected()
-    # IO defaults
-    assert mock_ddg1.burst_mode.get() == 0
-    assert mock_ddg1.ab.io.amplitude.get() == 5.0
-    assert mock_ddg1.cd.io.offset.get() == 0.0
-    assert mock_ddg1.ef.io.polarity.get() == 1
-    assert mock_ddg1.gh.io.ttl_mode.get() == 1
+    mock_ddg1.burst_mode.put(1)  # Set burst mode to 1, if connected should reset it to 0
+    mock_ddg1.burst_delay.put(5)  # Set to non-zero, should reset to 0 on connected
+    mock_ddg1.burst_count.put(10)  # Set to non-default, should reset to 1 on connected
+    with mock.patch.object(mock_ddg1, "set_io_values") as mock_set_io_values:
+        mock_ddg1.on_connected()
 
-    # reference defaults
-    assert mock_ddg1.ab.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg1.ab.ch2.reference.get() == 1  # CHANNELREFERENCE.A.value
-    assert mock_ddg1.cd.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg1.cd.ch2.reference.get() == 3  # CHANNELREFERENCE.C.value
-    assert mock_ddg1.ef.ch1.reference.get() == 4  # CHANNELREFERENCE.D.value
-    assert mock_ddg1.ef.ch2.reference.get() == 5  # CHANNELREFERENCE.E.value
-    assert mock_ddg1.gh.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg1.gh.ch2.reference.get() == 7  # CHANNELREFERENCE.G.value
+        # Burst mode Defaults
+        assert mock_ddg1.burst_mode.get() == 0
+        assert mock_ddg1.burst_delay.get() == 0
+        assert mock_ddg1.burst_count.get() == 1
 
-    # Default trigger source
-    assert mock_ddg1.trigger_source.get() == 5  # TRIGGERSOURCE.SINGLE_SHOT.value
+        assert mock_set_io_values.call_count == len(DDG1_DEFAULT_IO_CONFIG)
+        for ch, config in DDG1_DEFAULT_IO_CONFIG.items():
+            assert mock.call(ch, **config) in mock_set_io_values.call_args_list
+
+    # Check reference values from DEFAULT_REFERENCES
+    for ch, refs in DDG1_DEFAULT_REFERENCES:
+        if ch == "A":
+            sub_ch = mock_ddg1.ab.ch1
+        elif ch == "B":
+            sub_ch = mock_ddg1.ab.ch2
+        elif ch == "C":
+            sub_ch = mock_ddg1.cd.ch1
+        elif ch == "D":
+            sub_ch = mock_ddg1.cd.ch2
+        elif ch == "E":
+            sub_ch = mock_ddg1.ef.ch1
+        elif ch == "F":
+            sub_ch = mock_ddg1.ef.ch2
+        elif ch == "G":
+            sub_ch = mock_ddg1.gh.ch1
+        elif ch == "H":
+            sub_ch = mock_ddg1.gh.ch2
+        assert sub_ch.reference.get() == refs.value
+
+    # Check Default trigger source
+    assert mock_ddg1.trigger_source.get() == DDG1_DEFAULT_TRIGGER_SOURCE.value
+
+    # Check proc state mode
+    assert mock_ddg1.state.proc_status_mode.get() == PROC_EVENT_MODE.EVENT.value
+
+    # Check the poll thread is started
+    assert mock_ddg1._poll_thread.is_alive()
+    assert not mock_ddg1._poll_thread_kill_event.is_set()
+    assert not mock_ddg1._poll_thread_poll_loop_done.is_set()
+    assert not mock_ddg1._poll_thread_run_event.is_set()
 
 
-def test_ddg1_stage(mock_ddg1):
+def test_ddg1_prepare_mcs(mock_ddg1: DDG1, mock_mcs_csaxs: MCSCardCSAXS):
+    """Test the prepare_mcs method of DDG1."""
+    mcs = mock_mcs_csaxs
+    ddg = mock_ddg1
+    # Simulate default state
+    mcs.acquiring._read_pv.mock_data = 0  # not acquiring
+    mcs.erase_start.put(0)  # reset erase start
+
+    # Prepare MCS on trigger
+    st = ddg._prepare_mcs_on_trigger(mcs)
+    assert st.done is False
+    assert st.success is False
+    assert mcs.erase_start.get() == 1  # erase started
+
+    # Simulate acquiring started
+    mcs.acquiring._read_pv.mock_data = 1  # acquiring
+    st.wait(2)
+    assert st.done is True
+    assert st.success is True
+
+
+def test_ddg1_stage(mock_ddg1: DDG1):
     """Test the on_stage method of DDG1."""
     exp_time = 0.1
     frames_per_trigger = 10
 
-    mock_ddg1.burst_mode.put(1)
+    mock_ddg1.burst_mode.put(0)  # Non-default, should be reset on stage
+    mock_ddg1.burst_delay.put(5)  # Non-default, should be reset on stage
+    mock_ddg1.burst_count.put(10)  # Non-default, should be reset on stage
+
     mock_ddg1.scan_info.msg.scan_parameters["exp_time"] = exp_time
     mock_ddg1.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
 
     mock_ddg1.stage()
 
+    shutter_width = 2e-3 + exp_time * frames_per_trigger + 1e-3
+
     assert np.isclose(mock_ddg1.burst_mode.get(), 1)  # burst mode is enabled
     assert np.isclose(mock_ddg1.burst_delay.get(), 0)
-    assert np.isclose(mock_ddg1.burst_period.get(), exp_time)
+    assert np.isclose(mock_ddg1.burst_period.get(), shutter_width)
 
     # Trigger DDG2 through EXT/EN
-
     assert np.isclose(mock_ddg1.ab.delay.get(), 2e-3)
     assert np.isclose(mock_ddg1.ab.width.get(), 1e-6)
     # Shutter channel cd
     assert np.isclose(mock_ddg1.cd.delay.get(), 0)
-    assert np.isclose(mock_ddg1.cd.width.get(), 2e-3 + exp_time * frames_per_trigger + 1e-3)
+    assert np.isclose(mock_ddg1.cd.width.get(), shutter_width)
     # MCS channel ef or gate
     assert np.isclose(mock_ddg1.ef.delay.get(), 0)
     assert np.isclose(mock_ddg1.ef.width.get(), 1e-6)
@@ -209,96 +304,266 @@ def test_ddg1_stage(mock_ddg1):
     assert mock_ddg1.staged == ophyd.Staged.yes
 
 
-def test_ddg1_trigger(mock_ddg1):
-    """Test the on_trigger method of DDG1."""
-    mock_ddg1.state.event_status._read_pv.mock_data = STATUSBITS.NONE.value
+def test_ddg1_on_trigger(mock_ddg1: DDG1):
+    """
+    Test the on_trigger method of the DDG1.
+
+    We will test two scenarios:
+    I. Trigger is prepared, and resolves successfully after END_OF_BURST is reached in event status register.
+    II. Trigger is called while _poll_thread_loop_done is not yet finished from a previous trigger.
+        This may be the case if polling is yet to finsish. The next on_trigger should terminate the previous
+        polling, and work as expected. In addition, we will simulate that the mcs card is disabled, thus not prepared.
+    """
+    ddg = mock_ddg1
+    # Make sure DDG is setup in default state through on_connected
+    ddg.on_connected()
+
+    # Check that poll thread is running and run event is not set
+    assert ddg._poll_thread.is_alive()
+    assert not ddg._poll_thread_run_event.is_set()
+    assert not ddg._poll_thread_poll_loop_done.is_set()
+
+    # Set the status register bit
+    ddg.state.event_status._read_pv.mock_data = STATUSBITS.ABORT_DELAY.value
+
+    #################################
+    # Scenario I - normal operation #
+    #################################
+    with mock.patch.object(ddg, "_prepare_mcs_on_trigger") as mock_prepare_mcs:
+        mock_prepare_mcs.return_value = ophyd.StatusBase(done=True, success=True)
+        status = ddg.trigger()
+
+        # Check that the poll thread run event is set
+        assert ddg._poll_thread_run_event.is_set()
+        assert not ddg._poll_thread_poll_loop_done.is_set()
 
-    with mock.patch.object(mock_ddg1, "device_manager") as mock_device_manager:
-        # TODO add device manager DMMock, and properly test logic for mcs triggering.
-        mock_get = mock_device_manager.devices.get = mock.Mock(return_value=None)
-        status = mock_ddg1.trigger()
-        assert mock_get.call_args == mock.call("mcs", None)
         assert status.done is False
         assert status.success is False
-        assert mock_ddg1.trigger_shot.get() == 1
-        mock_ddg1.state.event_status._read_pv.mock_data = STATUSBITS.END_OF_BURST.value
+        assert ddg.trigger_shot.get() == 1
+
+        # Simulate that the event status bit reaches END_OF_BURST
+        ddg.state.event_status._read_pv.mock_data = STATUSBITS.END_OF_BURST.value
         status.wait(timeout=1)  # Wait for the status to be done
         assert status.done is True
         assert status.success is True
 
+        # Should finish the poll loop
+        ddg._poll_thread_poll_loop_done.wait(timeout=1)
+        assert not ddg._poll_thread_run_event.is_set()
 
-def test_ddg1_stop(mock_ddg1):
-    """Test the on_stop method of DDG1."""
-    mock_ddg1.burst_mode.put(1)  # Enable burst mode
-    mock_ddg1.stop()
-    assert mock_ddg1.burst_mode.get() == 0  # Burst mode is disabled
+    ############################################
+    # Scenario II - previous poll not finished #
+    # MCS card disabled                        #
+    ############################################
+
+    # Set mcs card to enabled = False
+    ddg.device_manager.devices["mcs"].enabled = False
+    ddg.state.event_status._read_pv.mock_data = STATUSBITS.ABORT_DELAY.value
+    ddg._start_polling()
+    assert ddg._poll_thread_run_event.is_set()
+    with mock.patch.object(ddg, "_prepare_mcs_on_trigger") as mock_prepare_mcs:
+        status = ddg.trigger()
+        mock_prepare_mcs.assert_not_called()  # MCS is disabled, should not be called
+        assert status.done is False
+        assert status.success is False
+
+        # Resolve the status by simulating END_OF_BURST
+        ddg.state.event_status._read_pv.mock_data = STATUSBITS.END_OF_BURST.value
+        status.wait(timeout=1)  # Wait for the status to be done
+        assert status.done is True
+        assert status.success is True
+
+        # Wait for poll loop to finish
+        ddg._poll_thread_poll_loop_done.wait(timeout=1)
+        assert not ddg._poll_thread_run_event.is_set()
 
 
-def test_ddg2_on_connected(mock_ddg2):
-    """Test on connected method of DDG2."""
-    mock_ddg2.on_connected()
-    # IO defaults
-    assert mock_ddg2.burst_mode.get() == 0
-    assert mock_ddg2.ab.io.amplitude.get() == 5.0
-    assert mock_ddg2.cd.io.offset.get() == 0.0
-    assert mock_ddg2.ef.io.polarity.get() == 1
-    assert mock_ddg2.gh.io.ttl_mode.get() == 1
+# def test_ddg1_trigger(mock_ddg1):
+#     """Test the on_trigger method of DDG1."""
+#     mock_ddg1.state.event_status._read_pv.mock_data = STATUSBITS.NONE.value
 
-    # reference defaults
-    assert mock_ddg2.ab.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg2.ab.ch2.reference.get() == 1  # CHANNELREFERENCE.A.value
-    assert mock_ddg2.cd.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg2.cd.ch2.reference.get() == 3  # CHANNELREFERENCE.C.value
-    assert mock_ddg2.ef.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg2.ef.ch2.reference.get() == 5  # CHANNELREFERENCE.E.value
-    assert mock_ddg2.gh.ch1.reference.get() == 0  # CHANNELREFERENCE.T0.value
-    assert mock_ddg2.gh.ch2.reference.get() == 7  # CHANNELREFERENCE.G.value
-
-    # Default trigger source
-    assert mock_ddg2.trigger_source.get() == 1  # TRIGGERSOURCE.EXT_RISING_EDGE.value
+#     with mock.patch.object(mock_ddg1, "device_manager") as mock_device_manager:
+#         # TODO add device manager DMMock, and properly test logic for mcs triggering.
+#         mock_get = mock_device_manager.devices.get = mock.Mock(return_value=None)
+#         status = mock_ddg1.trigger()
+#         assert mock_get.call_args == mock.call("mcs", None)
+#         assert status.done is False
+#         assert status.success is False
+#         assert mock_ddg1.trigger_shot.get() == 1
+#         mock_ddg1.state.event_status._read_pv.mock_data = STATUSBITS.END_OF_BURST.value
+#         status.wait(timeout=1)  # Wait for the status to be done
+#         assert status.done is True
+#         assert status.success is True
 
 
-def test_ddg2_stage(mock_ddg2):
-    """Test the on_stage method of DDG2."""
+# def test_ddg1_stop(mock_ddg1):
+#     """Test the on_stop method of DDG1."""
+#     mock_ddg1.burst_mode.put(1)  # Enable burst mode
+#     mock_ddg1.stop()
+#     assert mock_ddg1.burst_mode.get() == 0  # Burst mode is disabled
+
+
+#########################
+### Test DDG2 Device ####
+#########################
+
+
+@pytest.fixture(scope="function")
+def mock_ddg2(mock_mcs_csaxs: MCSCardCSAXS) -> Generator[DDG2, None, None]:
+    """Fixture to mock the DDG1 device."""
+    # Add enabled to mock_mcs_csaxs
+    dm_mock = mock_mcs_csaxs.device_manager
+    with patched_device(
+        DDG2, name="ddg2", prefix="test_ddg2:", device_manager=dm_mock, _mock_pv_initial_value=0
+    ) as dev:
+        dev.enabled = True
+        dev.device_manager.devices["ddg2"] = dev
+        try:
+            yield dev
+        finally:
+            dev.destroy()
+
+
+def test_ddg2_on_connected(mock_ddg2: DDG2):
+    """Test the on_connected method of DDG1."""
+    mock_ddg2.burst_mode.put(1)  # Set burst mode to 1, if connected should reset it to 0
+    mock_ddg2.burst_delay.put(5)  # Set to non-zero, should reset to 0 on connected
+    mock_ddg2.burst_count.put(10)  # Set to non-default, should reset to 1 on connected
+    with mock.patch.object(mock_ddg2, "set_io_values") as mock_set_io_values:
+        mock_ddg2.on_connected()
+        # Burst mode Defaults
+        assert mock_ddg2.burst_mode.get() == 0
+
+        assert mock_set_io_values.call_count == len(DDG2_DEFAULT_IO_CONFIG)
+        for ch, config in DDG2_DEFAULT_IO_CONFIG.items():
+            assert mock.call(ch, **config) in mock_set_io_values.call_args_list
+
+    # Check reference values from DEFAULT_REFERENCES
+    for ch, refs in DDG2_DEFAULT_REFERENCES:
+        if ch == "A":
+            sub_ch = mock_ddg2.ab.ch1
+        elif ch == "B":
+            sub_ch = mock_ddg2.ab.ch2
+        elif ch == "C":
+            sub_ch = mock_ddg2.cd.ch1
+        elif ch == "D":
+            sub_ch = mock_ddg2.cd.ch2
+        elif ch == "E":
+            sub_ch = mock_ddg2.ef.ch1
+        elif ch == "F":
+            sub_ch = mock_ddg2.ef.ch2
+        elif ch == "G":
+            sub_ch = mock_ddg2.gh.ch1
+        elif ch == "H":
+            sub_ch = mock_ddg2.gh.ch2
+        assert sub_ch.reference.get() == refs.value
+
+    # Check Default trigger source
+    assert mock_ddg2.trigger_source.get() == DDG2_DEFAULT_TRIGGER_SOURCE.value
+
+
+def test_ddg2_on_stage(mock_ddg2: DDG2):
+    """
+    Test the on_stage method of DDG2.
+
+    We will test two scenarios:
+    I. Stage device with valid parameters.
+    II. Stage device with invalid parameters (too short exp_time). Should raise ValueError.
+    """
+    ddg = mock_ddg2
     exp_time = 0.1
     frames_per_trigger = 10
-    mock_ddg2.on_connected()
+    ddg.on_connected()
+    ddg.scan_info.msg.scan_parameters["exp_time"] = exp_time
+    ddg.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
 
-    mock_ddg2.burst_mode.put(0)
-    mock_ddg2.scan_info.msg.scan_parameters["exp_time"] = exp_time
-    mock_ddg2.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
+    # Set non-default burst mode settings
+    ddg.burst_mode.put(0)
+    ddg.burst_delay.put(5)
 
-    mock_ddg2.stage()
+    # Stage device with valid parameters
+    ddg.stage()
+    assert ddg.staged == ophyd.Staged.yes
+    assert ddg.burst_mode.get() == 1  # Burst mode is enabled
+    assert ddg.burst_delay.get() == 0  # Burst delay is set to 0
+    assert ddg.burst_count.get() == frames_per_trigger
+    assert ddg.burst_period.get() == exp_time
 
-    assert np.isclose(mock_ddg2.burst_mode.get(), 1)  # Burst mode is enabled
-    assert np.isclose(mock_ddg2.ab.delay.get(), 0)
-    assert np.isclose(mock_ddg2.ab.width.get(), exp_time - 2e-4)  # DEFAULT_READOUT_TIMES["ab"])
-    assert mock_ddg2.burst_count.get() == frames_per_trigger
-    assert np.isclose(mock_ddg2.burst_delay.get(), 0)
-    assert np.isclose(mock_ddg2.burst_period.get(), exp_time)
-
-    assert mock_ddg2.trigger_source.get() == TRIGGERSOURCE.EXT_RISING_EDGE.value
-
-    assert mock_ddg2.staged == ophyd.Staged.yes
-    mock_ddg2.unstage()  # Reset staged state for next test
+    # Pulse width is exp_time - readout_time
+    burst_pulse_width = exp_time - DDG2_DEFAULT_READOUT_TIMES["ab"]
+    assert np.isclose(ddg.ab.delay.get(), 0)
+    assert np.isclose(ddg.ab.width.get(), burst_pulse_width)
 
+    # Unstage to reset
+    ddg.unstage()  # Reset staged state for next test
+    exp_time_short = 2e-4  # too short exposure time
     with pytest.raises(ValueError):
-        mock_ddg2.scan_info.msg.scan_parameters["exp_time"] = 2e-4  # too short exposure time
-        mock_ddg2.stage()
+        ddg.scan_info.msg.scan_parameters["exp_time"] = exp_time_short
+        ddg.stage()
 
 
-def test_ddg2_trigger(mock_ddg2):
+def test_ddg2_on_trigger(mock_ddg2: DDG2):
     """Test the on_trigger method of DDG2."""
-    mock_ddg2.trigger_shot.put(0)
-    status = mock_ddg2.trigger()
-    assert mock_ddg2.trigger_shot.get() == 0  # Should not trigger DDG2 via soft trigger
+    ddg = mock_ddg2
+    ddg.on_connected()
+    ddg.trigger_shot.put(0)
+    status = ddg.trigger()
+    assert ddg.trigger_shot.get() == 0  # Should not trigger DDG2 via soft trigger
     status.wait()
     assert status.done is True
     assert status.success is True
 
 
-def test_ddg2_stop(mock_ddg2):
+def test_ddg2_on_stop(mock_ddg2: DDG2):
     """Test the on_stop method of DDG2."""
-    mock_ddg2.burst_mode.put(1)  # Enable burst mode
-    mock_ddg2.stop()
-    assert mock_ddg2.burst_mode.get() == 0  # Burst mode is disabled
+    ddg = mock_ddg2
+    ddg.on_connected()
+    ddg.burst_mode.put(1)  # Enable burst mode
+    ddg.stop()
+    assert ddg.burst_mode.get() == 0  # Burst mode is disabled
+
+
+# def test_ddg2_stage(mock_ddg2):
+#     """Test the on_stage method of DDG2."""
+#     exp_time = 0.1
+#     frames_per_trigger = 10
+#     mock_ddg2.on_connected()
+
+#     mock_ddg2.burst_mode.put(0)
+#     mock_ddg2.scan_info.msg.scan_parameters["exp_time"] = exp_time
+#     mock_ddg2.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
+
+#     mock_ddg2.stage()
+
+#     assert np.isclose(mock_ddg2.burst_mode.get(), 1)  # Burst mode is enabled
+#     assert np.isclose(mock_ddg2.ab.delay.get(), 0)
+#     assert np.isclose(mock_ddg2.ab.width.get(), exp_time - 2e-4)  # DEFAULT_READOUT_TIMES["ab"])
+#     assert mock_ddg2.burst_count.get() == frames_per_trigger
+#     assert np.isclose(mock_ddg2.burst_delay.get(), 0)
+#     assert np.isclose(mock_ddg2.burst_period.get(), exp_time)
+
+#     assert mock_ddg2.trigger_source.get() == TRIGGERSOURCE.EXT_RISING_EDGE.value
+
+#     assert mock_ddg2.staged == ophyd.Staged.yes
+#     mock_ddg2.unstage()  # Reset staged state for next test
+
+#     with pytest.raises(ValueError):
+#         mock_ddg2.scan_info.msg.scan_parameters["exp_time"] = 2e-4  # too short exposure time
+#         mock_ddg2.stage()
+
+
+# def test_ddg2_trigger(mock_ddg2):
+#     """Test the on_trigger method of DDG2."""
+#     mock_ddg2.trigger_shot.put(0)
+#     status = mock_ddg2.trigger()
+#     assert mock_ddg2.trigger_shot.get() == 0  # Should not trigger DDG2 via soft trigger
+#     status.wait()
+#     assert status.done is True
+#     assert status.success is True
+
+
+# def test_ddg2_stop(mock_ddg2):
+#     """Test the on_stop method of DDG2."""
+#     mock_ddg2.burst_mode.put(1)  # Enable burst mode
+#     mock_ddg2.stop()
+#     assert mock_ddg2.burst_mode.get() == 0  # Burst mode is disabled

tests/tests_devices/test_falcon_csaxs.py

@@ -1,298 +1,230 @@
 # pylint: skip-file
 import os
 import threading
+from typing import Generator
 from unittest import mock
 
 import ophyd
 import pytest
 from bec_lib import messages
 from bec_lib.endpoints import MessageEndpoints
+from bec_lib.file_utils import get_full_path
 from bec_server.device_server.tests.utils import DMMock
-from ophyd_devices.tests.utils import MockPV
+from ophyd_devices.interfaces.base_classes.psi_device_base import DeviceStoppedError
+from ophyd_devices.tests.utils import patched_device
 
-from csaxs_bec.devices.epics.falcon_csaxs import FalconcSAXS, FalconTimeoutError
-from csaxs_bec.devices.tests_utils.utils import patch_dual_pvs
+from csaxs_bec.devices.epics.falcon_csaxs import (
+    ACQUIRESTATUS,
+    FalconcSAXS,
+    MappingSource,
+    TriggerSource,
+)
 
 
 @pytest.fixture(scope="function")
-def mock_det():
-    name = "falcon"
-    prefix = "X12SA-SITORO:"
+def mock_det() -> Generator[FalconcSAXS, None, None]:
+    """Fixture to mock the FalconcSAXS device."""
+    name = "mcs_csaxs"
+    prefix = "X12SA-MCS-CSAXS:"
     dm = DMMock()
-    with mock.patch.object(dm, "connector"):
-        with (
-            mock.patch(
-                "ophyd_devices.interfaces.base_classes.bec_device_base.FileWriter"
-            ) as filemixin,
-            mock.patch(
-                "ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_service_config"
-            ) as mock_service_config,
-        ):
-            with mock.patch.object(ophyd, "cl") as mock_cl:
-                mock_cl.get_pv = MockPV
-                mock_cl.thread_class = threading.Thread
-                with mock.patch.object(FalconcSAXS, "_init"):
-                    det = FalconcSAXS(name=name, prefix=prefix, device_manager=dm)
-                    patch_dual_pvs(det)
-                    det.TIMEOUT_FOR_SIGNALS = 0.1
-                    yield det
+    with patched_device(
+        FalconcSAXS,
+        name="falcon",
+        prefix="X12SA-SITORO:",
+        device_manager=dm,
+        _mock_pv_initial_value=1,
+    ) as dev:
+        try:
+            for dotted_name, device in dev.walk_subdevices(include_lazy=True):
+                device.stage_sigs = {}  # Remove stage signals
+                device.trigger_sigs = {}  # Remove trigger signals
+                if hasattr(device, "plugin_type"):
+                    device.plugin_type._read_pv.mock_data = device._plugin_type
+            yield dev
+        finally:
+            dev.destroy()
 
 
-@pytest.mark.parametrize(
-    "trigger_source, mapping_source, ignore_gate, pixels_per_buffer, detector_state,"
-    " expected_exception",
-    [(1, 1, 0, 20, 0, False), (1, 1, 0, 20, 1, True)],
-)
-# TODO rewrite this one, write test for init_detector, init_filewriter is tested
-def test_init_detector(
-    mock_det,
-    trigger_source,
-    mapping_source,
-    ignore_gate,
-    pixels_per_buffer,
-    detector_state,
-    expected_exception,
-):
-    """Test the _init function:
+def test_falcon_init(mock_det: FalconcSAXS):
+    """Test the initialization of the FalconcSAXS device."""
+    assert mock_det._readout_time == mock_det.MIN_READOUT
+    assert mock_det._value_pixel_per_buffer == 20
+    assert mock_det._queue_size == 2000
+    assert mock_det._full_path == ""
 
-    This includes testing the functions:
-    - _init_detector
-    - _stop_det
-    - _set_trigger
-    --> Testing the filewriter is done in test_init_filewriter
 
-    Validation upon setting the correct PVs
+def test_falcon_on_connected(mock_det: FalconcSAXS):
+    """Test the on_connected method of the FalconcSAXS device."""
+    falcon = mock_det
 
+    # Set known default values
+    falcon.preset_mode.put(-1)
+    falcon.input_logic_polarity.put(-1)
+    falcon.auto_pixels_per_buffer.put(-1)
+    falcon.hdf5.enable.put(-1)
+
+    with (
+        mock.patch.object(falcon, "on_stop") as mock_on_stop,
+        mock.patch.object(falcon, "set_trigger") as mock_set_trigger,
+    ):
+
+        falcon.on_connected()
+        mock_on_stop.assert_called_once()
+        mock_set_trigger.assert_called_once_with(
+            mapping_mode=MappingSource.MAPPING, trigger_source=TriggerSource.GATE, ignore_gate=0
+        )
+
+        # Detector default PV values
+        assert falcon.preset_mode.get() == "1"  # Real Time
+        assert falcon.input_logic_polarity.get() == 0
+        assert falcon.auto_pixels_per_buffer.get() == 0
+        assert falcon.pixels_per_buffer.get() == falcon._value_pixel_per_buffer
+
+        # Backend default PV values
+        assert falcon.hdf5.enable.get() == "1"  # Enabled
+        assert falcon.hdf5.xml_file_name.get() == "layout.xml"
+        assert falcon.hdf5.lazy_open.get() == "1"  # Enabled
+        assert falcon.hdf5.temp_suffix.get() == ""
+        assert falcon.hdf5.queue_size.get() == falcon._queue_size
+        assert falcon.nd_array_mode.get() == 1
+        assert falcon.hdf5.file_template.get() == "%s%s"
+        assert falcon.hdf5.file_write_mode.get() == 2
+
+
+def test_falcon_on_stage(mock_det: FalconcSAXS):
     """
-    mock_det.value_pixel_per_buffer = pixels_per_buffer
-    mock_det.state._read_pv.mock_data = detector_state
-    if expected_exception:
-        with pytest.raises(FalconTimeoutError):
-            mock_det.timeout = 0.1
-            mock_det.custom_prepare.initialize_detector()
-    else:
-        mock_det.custom_prepare.initialize_detector()
-        assert mock_det.state.get() == detector_state
-        assert mock_det.collect_mode.get() == mapping_source
-        assert mock_det.pixel_advance_mode.get() == trigger_source
-        assert mock_det.ignore_gate.get() == ignore_gate
 
-        assert mock_det.preset_mode.get() == 1
-        assert mock_det.erase_all.get() == 1
-        assert mock_det.input_logic_polarity.get() == 0
-        assert mock_det.auto_pixels_per_buffer.get() == 0
-        assert mock_det.pixels_per_buffer.get() == pixels_per_buffer
-
-
-@pytest.mark.parametrize(
-    "readout_time, expected_value", [(1e-3, 3e-3), (3e-3, 3e-3), (5e-3, 5e-3), (None, 3e-3)]
-)
-def test_update_readout_time(mock_det, readout_time, expected_value):
-    if readout_time is None:
-        mock_det.custom_prepare.update_readout_time()
-        assert mock_det.readout_time == expected_value
-    else:
-        mock_det.scaninfo.readout_time = readout_time
-        mock_det.custom_prepare.update_readout_time()
-        assert mock_det.readout_time == expected_value
-
-
-def test_initialize_default_parameter(mock_det):
-    with mock.patch.object(
-        mock_det.custom_prepare, "update_readout_time"
-    ) as mock_update_readout_time:
-        mock_det.custom_prepare.initialize_default_parameter()
-        assert mock_det.value_pixel_per_buffer == 20
-        mock_update_readout_time.assert_called_once()
-
-
-@pytest.mark.parametrize(
-    "scaninfo",
-    [
-        (
-            {
-                "eacc": "e12345",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-                "exp_time": 0.1,
-                "filepath": "test.h5",
-                "scan_id": "123",
-                "mokev": 12.4,
-            }
-        )
-    ],
-)
-def test_stage(mock_det, scaninfo):
-    """Test the stage function:
-
-    This includes testing _prep_det
+    Test the on_stage method of the FalconcSAXS device.
+    All relevant information is available in the scan_info attribute and used
+    to bootstrap the detector for the upcoming acquisition. Two scenarios are tested:
+    I. Normal case with exposure time larger than readout time
+    II. Case where exposure time is smaller than readout time, which should raise an exception.
     """
-    with (
-        mock.patch.object(mock_det.custom_prepare, "set_trigger") as mock_set_trigger,
-        mock.patch.object(
-            mock_det.custom_prepare, "prepare_data_backend"
-        ) as mock_prep_data_backend,
-        mock.patch.object(
-            mock_det.custom_prepare, "publish_file_location"
-        ) as mock_publish_file_location,
-        mock.patch.object(mock_det.custom_prepare, "arm_acquisition") as mock_arm_acquisition,
-    ):
-        mock_det.scaninfo.exp_time = scaninfo["exp_time"]
-        mock_det.scaninfo.num_points = scaninfo["num_points"]
-        mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-        mock_det.stage()
-        mock_set_trigger.assert_called_once()
-        assert mock_det.preset_real.get() == scaninfo["exp_time"]
-        assert mock_det.pixels_per_run.get() == int(
-            scaninfo["num_points"] * scaninfo["frames_per_trigger"]
-        )
-        mock_prep_data_backend.assert_called_once()
-        mock_publish_file_location.assert_called_once_with(done=False, successful=False)
-        mock_arm_acquisition.assert_called_once()
+    falcon = mock_det
+    num_points = 10
+    exp_time = 0.2
+    frames_per_trigger = 5
+    falcon.scan_info.msg.num_points = num_points
+    falcon.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
+    falcon.scan_info.msg.scan_parameters["exp_time"] = exp_time
+    falcon.hdf5.array_counter.put(5)  # Set to non-zero to check reset
+
+    # I. Normal case
+    falcon.stage()
+
+    assert falcon.staged is ophyd.Staged.yes
+    assert falcon._full_path == get_full_path(falcon.scan_info.msg, falcon.name)
+    file_path = falcon.hdf5.file_path.get()
+    file_name = falcon.hdf5.file_name.get()
+    assert os.path.join(file_path, file_name) == falcon._full_path
+
+    assert falcon.preset_real_time.get() == exp_time
+    assert falcon.pixels_per_run.get() == num_points * frames_per_trigger
+    assert falcon.hdf5.num_capture.get() == num_points * frames_per_trigger
+    assert falcon.hdf5.array_counter.get() == 0
+    assert falcon.hdf5.capture.get() == 1
+    assert falcon.start_all.get() == 1
+
+    # II. Unstage device first
+    falcon.unstage()
+    exp_time = 1e-3  # Smaller than readout time
+    falcon.scan_info.msg.scan_parameters["exp_time"] = exp_time
+    with pytest.raises(ValueError):
+        falcon.stage()
+        assert falcon.staged is not ophyd.Staged.no
 
 
-@pytest.mark.parametrize(
-    "scaninfo",
-    [
-        (
-            {
-                "filepath": "/das/work/p18/p18533/data/S00000-S00999/S00001/data.h5",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-            }
-        ),
-        (
-            {
-                "filepath": "/das/work/p18/p18533/data/S00000-S00999/S00001/data1234.h5",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-            }
-        ),
-    ],
-)
-def test_prepare_data_backend(mock_det, scaninfo):
-    mock_det.filewriter.compile_full_filename.return_value = scaninfo["filepath"]
-    mock_det.scaninfo.num_points = scaninfo["num_points"]
-    mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-    mock_det.scaninfo.scan_number = 1
-    mock_det.custom_prepare.prepare_data_backend()
-    file_path, file_name = os.path.split(scaninfo["filepath"])
-    assert mock_det.hdf5.file_path.get() == file_path
-    assert mock_det.hdf5.file_name.get() == file_name
-    assert mock_det.hdf5.file_template.get() == "%s%s"
-    assert mock_det.hdf5.num_capture.get() == int(
-        scaninfo["num_points"] * scaninfo["frames_per_trigger"]
+def test_falcon_on_pre_scan(mock_det: FalconcSAXS):
+    """Test the on_pre_scan method of the FalconcSAXS device."""
+    falcon = mock_det
+    # I. Test normal case with success
+    falcon.acquire_busy._read_pv.mock_data = ACQUIRESTATUS.DONE
+    falcon.hdf5.capture._read_pv.mock_data = ACQUIRESTATUS.DONE
+    falcon = mock_det
+    st = falcon.on_pre_scan()
+    assert st.done is False
+    assert st.success is False
+    falcon.acquire_busy._read_pv.mock_data = ACQUIRESTATUS.ACQUIRING
+    assert st.done is False
+    assert st.success is False
+    falcon.hdf5.capture._read_pv.mock_data = ACQUIRESTATUS.ACQUIRING
+    st.wait(3)
+    assert st.done is True
+    assert st.success is True
+
+    # II. Test abort case with stop called
+    falcon.acquire_busy._read_pv.mock_data = ACQUIRESTATUS.DONE
+    falcon.hdf5.capture._read_pv.mock_data = ACQUIRESTATUS.DONE
+    st = falcon.on_pre_scan()
+    assert st.done is False
+    assert st.success is False
+    falcon.stop()
+    with pytest.raises(DeviceStoppedError):
+        st.wait(3)
+    assert st.done is True
+    assert st.success is False
+
+
+def test_falcon_stop(mock_det: FalconcSAXS):
+    """Test the stop method of the FalconcSAXS device."""
+    falcon = mock_det
+
+    falcon.stop_all.put(0)
+    falcon.hdf5.capture.put(1)
+    falcon.erase_all.put(0)
+    falcon.stop()
+    assert falcon.stop_all.get() == 1
+    assert falcon.hdf5.capture.get() == 0
+    assert falcon.erase_all.get() == 1
+
+
+def test_falcon_complete(mock_det: FalconcSAXS):
+    """Test the complete method of the FalconcSAXS device."""
+    falcon = mock_det
+
+    num_points = 10
+    frames_per_trigger = 5
+    falcon.scan_info.msg.num_points = num_points
+    falcon.scan_info.msg.scan_parameters["frames_per_trigger"] = frames_per_trigger
+
+    # I. Test normal case with success
+    falcon.dxp.current_pixel._read_pv.mock_data = num_points * frames_per_trigger - 1
+    falcon.hdf5.array_counter._read_pv.mock_data = num_points * frames_per_trigger - 1
+    falcon._full_path = "/tmp/fake_path/test.h5"
+    st = falcon.on_complete()
+    assert st.done is False
+    assert st.success is False
+    falcon.dxp.current_pixel._read_pv.mock_data = num_points * frames_per_trigger
+    assert st.done is False
+    assert st.success is False
+    falcon.hdf5.array_counter._read_pv.mock_data = num_points * frames_per_trigger
+    st.wait(3)
+    assert st.done is True
+    assert st.success is True
+    assert falcon.file_event.get() == messages.FileMessage(
+        file_path="/tmp/fake_path/test.h5",
+        done=True,
+        successful=True,
+        device_name=falcon.name,
+        file_type="h5",
+        hinted_h5_entries=None,
+        metadata={},
     )
-    assert mock_det.hdf5.file_write_mode.get() == 2
-    assert mock_det.hdf5.array_counter.get() == 0
-    assert mock_det.hdf5.capture.get() == 1
 
-
-@pytest.mark.parametrize(
-    "scaninfo",
-    [
-        ({"filepath": "test.h5", "successful": True, "done": False, "scan_id": "123"}),
-        ({"filepath": "test.h5", "successful": False, "done": True, "scan_id": "123"}),
-    ],
-)
-def test_publish_file_location(mock_det, scaninfo):
-    mock_det.scaninfo.scan_id = scaninfo["scan_id"]
-    mock_det.filepath.set(scaninfo["filepath"]).wait()
-    mock_det.custom_prepare.publish_file_location(
-        done=scaninfo["done"], successful=scaninfo["successful"]
+    # II. Test case where acquisition fails due to interruption
+    falcon.dxp.current_pixel._read_pv.mock_data = num_points * frames_per_trigger - 1
+    st = falcon.on_complete()
+    assert st.done is False
+    assert st.success is False
+    falcon.stop()
+    with pytest.raises(DeviceStoppedError):
+        st.wait(3)
+    assert falcon.file_event.get() == messages.FileMessage(
+        file_path="/tmp/fake_path/test.h5",
+        done=True,
+        successful=False,
+        device_name=falcon.name,
+        file_type="h5",
+        hinted_h5_entries=None,
+        metadata={},
     )
-    if scaninfo["successful"] is None:
-        msg = messages.FileMessage(file_path=scaninfo["filepath"], done=scaninfo["done"])
-    else:
-        msg = messages.FileMessage(
-            file_path=scaninfo["filepath"], done=scaninfo["done"], successful=scaninfo["successful"]
-        )
-    expected_calls = [
-        mock.call(
-            MessageEndpoints.public_file(scaninfo["scan_id"], mock_det.name),
-            msg,
-            pipe=mock_det.connector.pipeline.return_value,
-        ),
-        mock.call(
-            MessageEndpoints.file_event(mock_det.name),
-            msg,
-            pipe=mock_det.connector.pipeline.return_value,
-        ),
-    ]
-    assert mock_det.connector.set_and_publish.call_args_list == expected_calls
-
-
-@pytest.mark.parametrize("detector_state, expected_exception", [(1, False), (0, True)])
-def test_arm_acquisition(mock_det, detector_state, expected_exception):
-    with mock.patch.object(mock_det, "stop") as mock_stop:
-        mock_det.state._read_pv.mock_data = detector_state
-        if expected_exception:
-            with pytest.raises(FalconTimeoutError):
-                mock_det.timeout = 0.1
-                mock_det.custom_prepare.arm_acquisition()
-                mock_stop.assert_called_once()
-        else:
-            mock_det.custom_prepare.arm_acquisition()
-            assert mock_det.start_all.get() == 1
-
-
-def test_trigger(mock_det):
-    with mock.patch.object(mock_det.custom_prepare, "on_trigger") as mock_on_trigger:
-        mock_det.trigger()
-        mock_on_trigger.assert_called_once()
-
-
-def test_complete(mock_det):
-    with (
-        mock.patch.object(mock_det.custom_prepare, "finished") as mock_finished,
-        mock.patch.object(
-            mock_det.custom_prepare, "publish_file_location"
-        ) as mock_publish_file_location,
-    ):
-        mock_det.stopped = False
-        mock_det.complete()
-        assert mock_finished.call_count == 1
-        call = mock.call(done=True, successful=True)
-        assert mock_publish_file_location.call_args == call
-
-
-def test_stop(mock_det):
-    with (
-        mock.patch.object(mock_det.custom_prepare, "stop_detector") as mock_stop_det,
-        mock.patch.object(
-            mock_det.custom_prepare, "stop_detector_backend"
-        ) as mock_stop_detector_backend,
-    ):
-        mock_det.stop()
-        mock_stop_det.assert_called_once()
-        mock_stop_detector_backend.assert_called_once()
-        assert mock_det.stopped is True
-
-
-@pytest.mark.parametrize(
-    "stopped, scaninfo",
-    [
-        (False, {"num_points": 500, "frames_per_trigger": 1}),
-        (True, {"num_points": 500, "frames_per_trigger": 1}),
-    ],
-)
-def test_finished(mock_det, stopped, scaninfo):
-    with (
-        mock.patch.object(mock_det.custom_prepare, "stop_detector") as mock_stop_det,
-        mock.patch.object(
-            mock_det.custom_prepare, "stop_detector_backend"
-        ) as mock_stop_file_writer,
-    ):
-        mock_det.stopped = stopped
-        mock_det.dxp.current_pixel._read_pv.mock_data = int(
-            scaninfo["num_points"] * scaninfo["frames_per_trigger"]
-        )
-        mock_det.hdf5.array_counter._read_pv.mock_data = int(
-            scaninfo["num_points"] * scaninfo["frames_per_trigger"]
-        )
-        mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-        mock_det.scaninfo.num_points = scaninfo["num_points"]
-        mock_det.custom_prepare.finished()
-        assert mock_det.stopped is stopped
-        mock_stop_det.assert_called_once()
-        mock_stop_file_writer.assert_called_once()

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,42 @@ 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)
+        finally:
+            controller_cls._reset_controller()
+            controller_cls._axes_per_controller = ctrl_axis_backup

tests/tests_devices/test_mcs_card.py

@@ -1,5 +1,7 @@
 # pylint: skip-file
 import threading
+from copy import deepcopy
+from typing import Generator
 from unittest import mock
 
 import numpy as np
@@ -8,6 +10,7 @@ import pytest
 from bec_lib import messages
 from bec_lib.endpoints import MessageEndpoints
 from bec_server.device_server.tests.utils import DMMock
+from ophyd_devices.interfaces.base_classes.psi_device_base import DeviceStoppedError
 from ophyd_devices.tests.utils import MockPV, patch_dual_pvs
 
 from csaxs_bec.devices.epics.mcs_card.mcs_card import (
@@ -21,7 +24,7 @@ from csaxs_bec.devices.epics.mcs_card.mcs_card import (
     READMODE,
     MCSCard,
 )
-from csaxs_bec.devices.epics.mcs_card.mcs_card_csaxs import READYTOREAD, MCSCardCSAXS
+from csaxs_bec.devices.epics.mcs_card.mcs_card_csaxs import MCSCardCSAXS
 
 
 @pytest.fixture(scope="function")
@@ -46,434 +49,237 @@ def test_mcs_card(mock_mcs_card):
 
 
 @pytest.fixture(scope="function")
-def mock_mcs_csaxs():
+def mock_mcs_csaxs() -> Generator[MCSCardCSAXS, None, None]:
     """Fixture to mock the MCSCardCSAXS device."""
     name = "mcs_csaxs"
     prefix = "X12SA-MCS-CSAXS:"
     dm = DMMock()
-    with mock.patch.object(ophyd, "cl") as mock_cl:
-        mock_cl.get_pv = MockPV
-        mock_cl.thread_class = threading.Thread
-        mcs_card_csaxs = MCSCardCSAXS(name=name, prefix=prefix, device_manager=dm)
-        patch_dual_pvs(mcs_card_csaxs)
-        yield mcs_card_csaxs
+    try:
+        with mock.patch.object(ophyd, "cl") as mock_cl:
+            mock_cl.get_pv = MockPV
+            mock_cl.thread_class = threading.Thread
+            mcs_card_csaxs = MCSCardCSAXS(name=name, prefix=prefix, device_manager=dm)
+            patch_dual_pvs(mcs_card_csaxs)
+            yield mcs_card_csaxs
+    finally:
+        mcs_card_csaxs.on_destroy()
 
 
-def test_mcs_card_csaxs(mock_mcs_csaxs):
+def test_mcs_card_csaxs(mock_mcs_csaxs: MCSCardCSAXS):
     """Test the MCSCardCSAXS initialization."""
     assert mock_mcs_csaxs.name == "mcs_csaxs"
     assert mock_mcs_csaxs.prefix == "X12SA-MCS-CSAXS:"
-    assert mock_mcs_csaxs.counter_mapping == {
-        "mcs_csaxs_counters_mca1": "current1",
-        "mcs_csaxs_counters_mca2": "current2",
-        "mcs_csaxs_counters_mca3": "current3",
-        "mcs_csaxs_counters_mca4": "current4",
-        "mcs_csaxs_counters_mca5": "count_time",
-    }
-    assert mock_mcs_csaxs._mcs_clock == 1e7  # 10 MHz
+    assert mock_mcs_csaxs._acquisition_group == "monitored"
+    assert mock_mcs_csaxs._num_total_triggers == 0
+    assert mock_mcs_csaxs._mcs_clock == 1e7
+    assert mock_mcs_csaxs._pv_timeout == 2.0
+    assert mock_mcs_csaxs._mca_counter_index == 0
+    assert mock_mcs_csaxs._current_data_index == 0
+    assert mock_mcs_csaxs._current_data == {}
+    assert mock_mcs_csaxs.NUM_MCA_CHANNELS == 32
 
 
-def test_mcs_card_csaxs_on_connected(mock_mcs_csaxs):
+def test_mcs_card_csaxs_on_connected(mock_mcs_csaxs: MCSCardCSAXS):
     """Test the on_connected method of MCSCardCSAXS."""
     mcs = mock_mcs_csaxs
-    mcs.on_connected()
-    # Stop called
-    assert mcs.stop_all.get() == 1
-    # Channel advance settings
-    assert mcs.channel_advance.get() == CHANNELADVANCE.EXTERNAL
-    assert mcs.channel1_source.get() == CHANNEL1SOURCE.EXTERNAL
-    assert mcs.prescale.get() == 1
-    #
-    assert mcs.user_led.get() == 0
-    # Only 5 channels are connected
-    assert mcs.mux_output.get() == 5
-    # input output settings
-    assert mcs.input_mode.get() == INPUTMODE.MODE_3
-    assert mcs.input_polarity.get() == POLARITY.NORMAL
-    assert mcs.output_mode.get() == OUTPUTMODE.MODE_2
-    assert mcs.output_polarity.get() == POLARITY.NORMAL
-    assert mcs.count_on_start.get() == 0
-    assert mcs.read_mode.get() == READMODE.PASSIVE
-    assert mcs.acquire_mode.get() == ACQUIREMODE.MCS
-
-    with mock.patch.object(mcs.counters.mca1, "subscribe") as mock_mca_subscribe:
+    with (
+        mock.patch.object(mcs.counters.mca1, "subscribe") as mock_mca_subscribe,
+        mock.patch.object(mcs, "mcs_recovery") as mock_mcs_recovery,
+        mock.patch.object(mcs._scan_done_thread, "start") as mock_scan_done_thread_start,
+    ):
         mcs.on_connected()
+        # Stop called
+        assert mcs.stop_all.get() == 1
+        # Channel advance settings
+        assert mcs.channel_advance.get() == CHANNELADVANCE.EXTERNAL
+        assert mcs.channel1_source.get() == CHANNEL1SOURCE.EXTERNAL
+        assert mcs.prescale.get() == 1
+        assert mcs.user_led.get() == 0
+
+        # Mux output
+        assert mcs.mux_output.get() == mcs.NUM_MCA_CHANNELS
+
+        # input output settings
+        assert mcs.input_mode.get() == INPUTMODE.MODE_3
+        assert mcs.input_polarity.get() == POLARITY.NORMAL
+        assert mcs.output_mode.get() == OUTPUTMODE.MODE_2
+        assert mcs.output_polarity.get() == POLARITY.NORMAL
+        assert mcs.count_on_start.get() == 0
+        assert mcs.read_mode.get() == READMODE.PASSIVE
+        assert mcs.acquire_mode.get() == ACQUIREMODE.MCS
+
+        # Check if subscriptions are setup correctly
         assert mock_mca_subscribe.call_args == mock.call(mcs._on_counter_update, run=False)
+        # Check if recovery is called
+        mock_mcs_recovery.assert_called_once_with(timeout=1)
+        # Check if scan done thread is started
+        mock_scan_done_thread_start.assert_called_once()
 
 
-def test_mcs_card_csaxs_stage(mock_mcs_csaxs):
+def test_mcs_card_csaxs_stage(mock_mcs_csaxs: MCSCardCSAXS):
     """Test on stage method of MCSCardCSAXS"""
     mcs = mock_mcs_csaxs
     triggers = 5
+    num_points = 10
     mcs.scan_info.msg.scan_parameters["frames_per_trigger"] = triggers
-    mcs.erase_all.put(0)
+    mcs.scan_info.msg.num_points = num_points
+
+    # Simulate that the MCS card is still acquiring, and that current channel is !=0
+    mcs.current_channel._read_pv.mock_data = 2  # Simulate that current channel is not zero
+    mcs.erase_all.put(0)  # Set erase_all to 0
+    mcs._current_data = {"mca1": [1, 2, 3]}  # Simulate existing data
+    mcs._scan_done_callbacks = [lambda: None]  # Simulate existing callbacks
+    mcs._start_monitor_async_data_emission.set()  # Simulate that monitoring is started
+    mcs._omit_mca_callbacks.set()  # Simulate that mca callbacks are omitted
+
     mcs.stage()
+    # Check that card is staged
     assert mcs._staged == ophyd.Staged.yes
-    assert mcs.erase_all.get() == 1
+
+    # Check that erase_all, stop_all, preset_real, num_use_all are set correctly
+    assert mcs.erase_all.get() == 1  # Should be set to 1 as current_channel !=0
     assert mcs.preset_real.get() == 0
     assert mcs.num_use_all.get() == triggers
 
+    # Check that internal variables are reset
+    assert mcs._num_total_triggers == triggers * num_points
+    assert mcs._current_data == {}
+    assert mcs._scan_done_callbacks == []
+    assert mcs._current_data_index == 0
+
+    # Check that thread events are cleared properly
+    assert not mcs._start_monitor_async_data_emission.is_set()
+    assert not mcs._omit_mca_callbacks.is_set()
+
 
 def test_mcs_card_csaxs_unstage(mock_mcs_csaxs):
     """Test unstage method of MCSCardCSAXS"""
     mcs = mock_mcs_csaxs
     mcs.stop_all.put(0)
-    mcs.ready_to_read.put(0)
-    mcs.erase_all.put(1)
+    mcs.erase_all.put(0)
     mcs.unstage()
     assert mcs.stop_all.get() == 1
-    assert mcs.ready_to_read.get() == READYTOREAD.DONE
-    assert mcs.erase_all.get() == 0
+    assert mcs.erase_all.get() == 1
 
 
-def test_mcs_card_csaxs_complete_and_stop(mock_mcs_csaxs):
-    """Test complete method of MCSCarcCSAXS"""
+def test_mcs_card_csaxs_complete_and_stop(mock_mcs_csaxs: MCSCardCSAXS):
+    """
+    Test complete method of MCSCarcCSAXS.
+
+    Two use cases:
+    I. Acquisition is stopped externally
+    II. Acquisition completes normally
+    """
     mcs = mock_mcs_csaxs
     mcs.acquiring._read_pv.mock_data = ACQUIRING.ACQUIRING
+    # Make sure that device on_connected has been called which starts the monitoring thread
+    mcs.on_connected()
+
+    #######################
+    # I. Use case where acquisition is stopped
+    #######################
+
     st = mcs.complete()
     assert st.done is False
-    mcs.stop_all.put(0)
-    mcs.ready_to_read.put(READYTOREAD.PROCESSING)
+    assert mcs._start_monitor_async_data_emission.is_set()
+
+    # Status should be cancelled by stop
     mcs.stop()
-    with pytest.raises(Exception):
+    with pytest.raises(DeviceStoppedError):
         st.wait(timeout=3)
+
+    # Callback on status failure should stop monitoring
+    mcs._start_monitor_async_data_emission.wait(2)
+    assert not mcs._start_monitor_async_data_emission.is_set()
+
+    #######################
+    # II. Use case where acquisition completes normally
+    #######################
+
+    mcs._current_data_index = 0
+    mcs.scan_info.msg.num_points = 10
+    mcs.acquiring._read_pv.mock_data = ACQUIRING.ACQUIRING
+
+    st = mcs.complete()
+    assert st.done is False
+    assert mcs._start_monitor_async_data_emission.is_set()
+
+    mcs.acquiring._read_pv.mock_data = ACQUIRING.DONE
+
+    # This should now automatically complete the status
+    mcs._current_data_index = 10
+    st.wait(timeout=3)
     assert st.done is True
-    assert st.success is False
-    assert mcs.stop_all.get() == 1
-    assert mcs.ready_to_read.get() == READYTOREAD.DONE
+    assert st.success is True
+
+    # Clean up procedure should stop the async_data monitoring
+    mcs._start_monitor_async_data_emission.wait(2)
+    assert not mcs._start_monitor_async_data_emission.is_set()
 
 
-def test_mcs_card_csaxs_on_counter_updated(mock_mcs_csaxs):
+def test_mcs_recovery(mock_mcs_csaxs: MCSCardCSAXS):
     mcs = mock_mcs_csaxs
-    # Called for mca1
+    # Simulate ongoing acquisition
+    mcs.erase_all._read_pv.mock_data = 0
+    mcs.stop_all._read_pv.mock_data = 0
+    mcs.erase_start.put(0)
+    mcs.mcs_recovery(timeout=0.1)
+    assert mcs.erase_all.get() == 1
+    assert mcs.stop_all.get() == 1
+    assert mcs.erase_start.get() == 1
+    assert not mcs._omit_mca_callbacks.is_set()
+
+
+def test_mcs_card_csaxs_on_counter_updated(mock_mcs_csaxs: MCSCardCSAXS):
+    """
+    Test the on_counter_update method of MCSCardCSAXS.
+    We will test 2 use cases:
+    I. Suppressed callbacks
+    II. Callback from 32 mca counters, should result in data being sent to BEC
+    """
+    mcs = mock_mcs_csaxs
+
+    # I. Suppressed callbacks
+    mcs._omit_mca_callbacks.set()
     kwargs = {"obj": mcs.counters.mca1}
     mcs._on_counter_update(1, **kwargs)
-    assert mcs.mcs.mca1.get() == 1
-    assert mcs.bpm.current1.get() == 1
-    assert mcs.counter_updated == [mcs.counters.mca1.name]
-    # Called for mca2
-    kwargs = {"obj": mcs.counters.mca2}
-    mcs._on_counter_update(np.array([2, 4]), **kwargs)
-    assert mcs.mcs.mca2.get() == [2, 4]
-    assert np.isclose(mcs.bpm.current2.get(), 3)
-    assert mcs.counter_updated == [mcs.counters.mca1.name, mcs.counters.mca2.name]
-    # Called for mca3
-    kwargs = {"obj": mcs.counters.mca3}
-    mcs._on_counter_update(1000, **kwargs)
-    assert mcs.mcs.mca3.get() == 1000
-    assert mcs.bpm.current3.get() == 1000
-    assert mcs.counter_updated == [
-        mcs.counters.mca1.name,
-        mcs.counters.mca2.name,
-        mcs.counters.mca3.name,
-    ]
-    # Called for mca4
-    kwargs = {"obj": mcs.counters.mca4}
-    mcs._on_counter_update(np.array([20, 40]), **kwargs)
-    assert mcs.mcs.mca4.get() == [20, 40]
-    assert np.isclose(mcs.bpm.current4.get(), 30)
-    assert mcs.counter_updated == [
-        mcs.counters.mca1.name,
-        mcs.counters.mca2.name,
-        mcs.counters.mca3.name,
-        mcs.counters.mca4.name,
-    ]
-    # Called for mca5
-    assert mcs.ready_to_read.get() == 0
-    kwargs = {"obj": mcs.counters.mca5}
-    mcs._on_counter_update(np.array([10000, 10000]), **kwargs)
-    assert np.isclose(mcs.bpm.count_time.get(), 10000 / 1e7)
-    assert mcs.mcs.mca5.get() == [10000, 10000]
+    assert mcs._current_data == {}
 
+    # II. Callback from 32 mca counters
+    mcs._omit_mca_callbacks.clear()
+    mcs._mca_counter_index = 0
+    mcs._current_data_index = 0
+    val = mcs.mca.get()
 
-# @pytest.fixture(scope="function")
-# def mock_det():
-#     name = "mcs"
-#     prefix = "X12SA-MCS:"
-#     dm = DMMock()
-#     with mock.patch.object(dm, "connector"):
-#         with (
-#             mock.patch(
-#                 "ophyd_devices.interfaces.base_classes.bec_device_base.FileWriter"
-#             ) as filemixin,
-#             mock.patch(
-#                 "ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_service_config"
-#             ) as mock_service_config,
-#         ):
-#             with mock.patch.object(ophyd, "cl") as mock_cl:
-#                 mock_cl.get_pv = MockPV
-#                 mock_cl.thread_class = threading.Thread
-#                 with mock.patch.object(MCScSAXS, "_init"):
-#                     det = MCScSAXS(name=name, prefix=prefix, device_manager=dm)
-#                     patch_dual_pvs(det)
-#                     det.TIMEOUT_FOR_SIGNALS = 0.1
-#                     yield det
+    for ii in range(mcs.NUM_MCA_CHANNELS):
+        counter = getattr(mcs.counters, f"mca{ii+1}")
+        kwargs = {"obj": counter, "timestamp": 1.0}
+        if ii % 2 == 1:
+            value = np.array([ii, (ii + 1) * 2])
+        else:
+            value = ii
+        mcs._on_counter_update(value, **kwargs)
+        if ii < (mcs.NUM_MCA_CHANNELS - 1):
+            assert mcs._current_data_index == 0
+            assert mcs._mca_counter_index == ii + 1
+            assert counter.attr_name in mcs._current_data
+            assert (
+                mcs._current_data[counter.attr_name]["value"] == value.tolist()
+                if isinstance(value, np.ndarray)
+                else [value]
+            )
+            buffer = deepcopy(mcs._current_data)
+            assert mcs.mca.get() == val  # Async mca signal should not change
+        else:
+            # On last counter, data should be sent to BEC, and internal variables reset
+            buffer[counter.attr_name] = {
+                "value": value.tolist() if isinstance(value, np.ndarray) else [value],
+                "timestamp": 1.0,
+            }
+            assert mcs._mca_counter_index == 0
+            assert mcs._current_data_index == 1
+            assert mcs._current_data == {}
 
-
-# def test_init():
-#     """Test the _init function:"""
-#     name = "eiger"
-#     prefix = "X12SA-ES-EIGER9M:"
-#     dm = DMMock()
-#     with mock.patch.object(dm, "connector"):
-#         with (
-#             mock.patch("ophyd_devices.interfaces.base_classes.bec_device_base.FileWriter"),
-#             mock.patch(
-#                 "ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_service_config"
-#             ),
-#         ):
-#             with mock.patch.object(ophyd, "cl") as mock_cl:
-#                 mock_cl.get_pv = MockPV
-#                 with (
-#                     mock.patch(
-#                         "csaxs_bec.devices.epics.mcs_csaxs.MCSSetup.initialize_detector"
-#                     ) as mock_init_det,
-#                     mock.patch(
-#                         "csaxs_bec.devices.epics.mcs_csaxs.MCSSetup.initialize_detector_backend"
-#                     ) as mock_init_backend,
-#                 ):
-#                     MCScSAXS(name=name, prefix=prefix, device_manager=dm)
-#                     mock_init_det.assert_called_once()
-#                     mock_init_backend.assert_called_once()
-
-
-# @pytest.mark.parametrize(
-#     "trigger_source, channel_advance, channel_source1, pv_channels",
-#     [
-#         (
-#             3,
-#             1,
-#             0,
-#             {
-#                 "user_led": 0,
-#                 "mux_output": 5,
-#                 "input_pol": 0,
-#                 "output_pol": 1,
-#                 "count_on_start": 0,
-#                 "stop_all": 1,
-#             },
-#         )
-#     ],
-# )
-# def test_initialize_detector(
-#     mock_det, trigger_source, channel_advance, channel_source1, pv_channels
-# ):
-#     """Test the _init function:
-
-#     This includes testing the functions:
-#     - initialize_detector
-#     - stop_det
-#     - parent.set_trigger
-#     --> Testing the filewriter is done in test_init_filewriter
-
-#     Validation upon setting the correct PVs
-
-#     """
-#     mock_det.custom_prepare.initialize_detector()  # call the method you want to test
-#     assert mock_det.channel_advance.get() == channel_advance
-#     assert mock_det.channel1_source.get() == channel_source1
-#     assert mock_det.user_led.get() == pv_channels["user_led"]
-#     assert mock_det.mux_output.get() == pv_channels["mux_output"]
-#     assert mock_det.input_polarity.get() == pv_channels["input_pol"]
-#     assert mock_det.output_polarity.get() == pv_channels["output_pol"]
-#     assert mock_det.count_on_start.get() == pv_channels["count_on_start"]
-#     assert mock_det.input_mode.get() == trigger_source
-
-
-# def test_trigger(mock_det):
-#     """Test the trigger function:
-#     Validate that trigger calls the custom_prepare.on_trigger() function
-#     """
-#     with mock.patch.object(mock_det.custom_prepare, "on_trigger") as mock_on_trigger:
-#         mock_det.trigger()
-#         mock_on_trigger.assert_called_once()
-
-
-# @pytest.mark.parametrize(
-#     "value, num_lines, num_points, done", [(100, 5, 500, False), (500, 5, 500, True)]
-# )
-# def test_progress_update(mock_det, value, num_lines, num_points, done):
-#     mock_det.num_lines.set(num_lines)
-#     mock_det.scaninfo.num_points = num_points
-#     calls = mock.call(sub_type="progress", value=value, max_value=num_points, done=done)
-#     with mock.patch.object(mock_det, "_run_subs") as mock_run_subs:
-#         mock_det.custom_prepare._progress_update(value=value)
-#         mock_run_subs.assert_called_once()
-#         assert mock_run_subs.call_args == calls
-
-
-# @pytest.mark.parametrize(
-#     "values, expected_nothing",
-#     [([[100, 120, 140], [200, 220, 240], [300, 320, 340]], False), ([100, 200, 300], True)],
-# )
-# def test_on_mca_data(mock_det, values, expected_nothing):
-#     """Test the on_mca_data function:
-#     Validate that on_mca_data calls the custom_prepare.on_mca_data() function
-#     """
-#     with mock.patch.object(mock_det.custom_prepare, "_send_data_to_bec") as mock_send_data:
-#         mock_object = mock.MagicMock()
-#         for ii, name in enumerate(mock_det.custom_prepare.mca_names):
-#             mock_object.attr_name = name
-#             mock_det.custom_prepare._on_mca_data(obj=mock_object, value=values[ii])
-#             if not expected_nothing and ii < (len(values) - 1):
-#                 assert mock_det.custom_prepare.mca_data[name] == values[ii]
-
-#         if not expected_nothing:
-#             mock_send_data.assert_called_once()
-#             assert mock_det.custom_prepare.acquisition_done is True
-
-
-# @pytest.mark.parametrize(
-#     "metadata, mca_data",
-#     [
-#         (
-#             {"scan_id": 123},
-#             {
-#                 "mca1": {"value": [100, 120, 140]},
-#                 "mca3": {"value": [200, 220, 240]},
-#                 "mca4": {"value": [300, 320, 340]},
-#             },
-#         )
-#     ],
-# )
-# def test_send_data_to_bec(mock_det, metadata, mca_data):
-#     mock_det.scaninfo.scan_msg = mock.MagicMock()
-#     mock_det.scaninfo.scan_msg.metadata = metadata
-#     mock_det.scaninfo.scan_id = metadata["scan_id"]
-#     mock_det.custom_prepare.mca_data = mca_data
-#     mock_det.custom_prepare._send_data_to_bec()
-#     device_metadata = mock_det.scaninfo.scan_msg.metadata
-#     metadata.update({"async_update": "append", "num_lines": mock_det.num_lines.get()})
-#     data = messages.DeviceMessage(signals=dict(mca_data), metadata=device_metadata)
-#     calls = mock.call(
-#         topic=MessageEndpoints.device_async_readback(
-#             scan_id=metadata["scan_id"], device=mock_det.name
-#         ),
-#         msg={"data": data},
-#         expire=1800,
-#     )
-
-#     assert mock_det.connector.xadd.call_args == calls
-
-
-# @pytest.mark.parametrize(
-#     "scaninfo, triggersource, stopped, expected_exception",
-#     [
-#         (
-#             {"num_points": 500, "frames_per_trigger": 1, "scan_type": "step"},
-#             TriggerSource.MODE3,
-#             False,
-#             False,
-#         ),
-#         (
-#             {"num_points": 500, "frames_per_trigger": 1, "scan_type": "fly"},
-#             TriggerSource.MODE3,
-#             False,
-#             False,
-#         ),
-#         (
-#             {"num_points": 5001, "frames_per_trigger": 2, "scan_type": "step"},
-#             TriggerSource.MODE3,
-#             False,
-#             True,
-#         ),
-#         (
-#             {"num_points": 500, "frames_per_trigger": 2, "scan_type": "random"},
-#             TriggerSource.MODE3,
-#             False,
-#             True,
-#         ),
-#     ],
-# )
-# def test_stage(mock_det, scaninfo, triggersource, stopped, expected_exception):
-#     mock_det.scaninfo.num_points = scaninfo["num_points"]
-#     mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-#     mock_det.scaninfo.scan_type = scaninfo["scan_type"]
-#     mock_det.stopped = stopped
-#     with mock.patch.object(mock_det.custom_prepare, "prepare_detector_backend") as mock_prep_fw:
-#         if expected_exception:
-#             with pytest.raises(MCSError):
-#                 mock_det.stage()
-#                 mock_prep_fw.assert_called_once()
-#         else:
-#             mock_det.stage()
-#             mock_prep_fw.assert_called_once()
-#             # Check set_trigger
-#             mock_det.input_mode.get() == triggersource
-#             if scaninfo["scan_type"] == "step":
-#                 assert mock_det.num_use_all.get() == int(scaninfo["frames_per_trigger"]) * int(
-#                     scaninfo["num_points"]
-#                 )
-#             elif scaninfo["scan_type"] == "fly":
-#                 assert mock_det.num_use_all.get() == int(scaninfo["num_points"])
-#             mock_det.preset_real.get() == 0
-
-#         # # CHeck custom_prepare.arm_acquisition
-#         # assert mock_det.custom_prepare.counter == 0
-#         # assert mock_det.erase_start.get() == 1
-#         # mock_prep_fw.assert_called_once()
-#         # # Check _prep_det
-#         # assert mock_det.cam.num_images.get() == int(
-#         #     scaninfo["num_points"] * scaninfo["frames_per_trigger"]
-#         # )
-#         # assert mock_det.cam.num_frames.get() == 1
-
-#         # mock_publish_file_location.assert_called_with(done=False)
-#         # assert mock_det.cam.acquire.get() == 1
-
-
-# def test_prepare_detector_backend(mock_det):
-#     mock_det.custom_prepare.prepare_detector_backend()
-#     assert mock_det.erase_all.get() == 1
-#     assert mock_det.read_mode.get() == ReadoutMode.EVENT
-
-
-# def test_complete(mock_det):
-#     with (mock.patch.object(mock_det.custom_prepare, "finished") as mock_finished,):
-#         mock_det.complete()
-#         assert mock_finished.call_count == 1
-
-
-# def test_stop_detector_backend(mock_det):
-#     mock_det.custom_prepare.stop_detector_backend()
-#     assert mock_det.custom_prepare.acquisition_done is True
-
-
-# def test_stop(mock_det):
-#     with (
-#         mock.patch.object(mock_det.custom_prepare, "stop_detector") as mock_stop_det,
-#         mock.patch.object(
-#             mock_det.custom_prepare, "stop_detector_backend"
-#         ) as mock_stop_detector_backend,
-#     ):
-#         mock_det.stop()
-#         mock_stop_det.assert_called_once()
-#         mock_stop_detector_backend.assert_called_once()
-#         assert mock_det.stopped is True
-
-
-# @pytest.mark.parametrize(
-#     "stopped, acquisition_done, acquiring_state, expected_exception",
-#     [
-#         (False, True, 0, False),
-#         (False, False, 0, True),
-#         (False, True, 1, True),
-#         (True, True, 0, True),
-#     ],
-# )
-# def test_finished(mock_det, stopped, acquisition_done, acquiring_state, expected_exception):
-#     mock_det.custom_prepare.acquisition_done = acquisition_done
-#     mock_det.acquiring._read_pv.mock_data = acquiring_state
-#     mock_det.scaninfo.num_points = 500
-#     mock_det.num_lines.put(500)
-#     mock_det.current_channel._read_pv.mock_data = 1
-#     mock_det.stopped = stopped
-
-#     if expected_exception:
-#         with pytest.raises(MCSTimeoutError):
-#             mock_det.timeout = 0.1
-#             mock_det.custom_prepare.finished()
-#     else:
-#         mock_det.custom_prepare.finished()
-#         if stopped:
-#             assert mock_det.stopped is stopped
+            # Check that the async mca signal is properly set
+            assert isinstance(mcs.mca.get(), messages.DeviceMessage)
+            assert len(mcs.mca.get().signals) == mcs.NUM_MCA_CHANNELS

tests/tests_devices/test_pilatus_csaxs.py

@@ -1,449 +0,0 @@
-# pylint: skip-file
-import os
-import threading
-from unittest import mock
-
-import ophyd
-import pytest
-from bec_lib import messages
-from bec_lib.endpoints import MessageEndpoints
-from bec_server.device_server.tests.utils import DMMock
-from ophyd_devices.tests.utils import MockPV
-
-from csaxs_bec.devices.epics.pilatus_csaxs import PilatuscSAXS
-from csaxs_bec.devices.tests_utils.utils import patch_dual_pvs
-
-
-@pytest.fixture(scope="function")
-def mock_det():
-    name = "pilatus"
-    prefix = "X12SA-ES-PILATUS300K:"
-    dm = DMMock()
-    with mock.patch.object(dm, "connector"):
-        with (
-            mock.patch("ophyd_devices.interfaces.base_classes.bec_device_base.FileWriter"),
-            mock.patch(
-                "ophyd_devices.interfaces.base_classes.psi_detector_base.PSIDetectorBase._update_service_config"
-            ),
-        ):
-            with mock.patch.object(ophyd, "cl") as mock_cl:
-                mock_cl.get_pv = MockPV
-                mock_cl.thread_class = threading.Thread
-                with mock.patch.object(PilatuscSAXS, "_init"):
-                    det = PilatuscSAXS(name=name, prefix=prefix, device_manager=dm)
-                    patch_dual_pvs(det)
-                    yield det
-
-
-@pytest.mark.parametrize("trigger_source, detector_state", [(1, 0)])
-# TODO rewrite this one, write test for init_detector, init_filewriter is tested
-def test_init_detector(mock_det, trigger_source, detector_state):
-    """Test the _init function:
-
-    This includes testing the functions:
-    - _init_detector
-    - _stop_det
-    - _set_trigger
-    --> Testing the filewriter is done in test_init_filewriter
-
-    Validation upon setting the correct PVs
-
-    """
-    mock_det.custom_prepare.on_init()  # call the method you want to test
-    assert mock_det.cam.acquire.get() == detector_state
-    assert mock_det.cam.trigger_mode.get() == trigger_source
-
-
-@pytest.mark.parametrize(
-    "scaninfo, stopped, expected_exception",
-    [
-        (
-            {
-                "eacc": "e12345",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-                "filepath": "test.h5",
-                "scan_id": "123",
-                "mokev": 12.4,
-            },
-            False,
-            False,
-        ),
-        (
-            {
-                "eacc": "e12345",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-                "filepath": "test.h5",
-                "scan_id": "123",
-                "mokev": 12.4,
-            },
-            True,
-            False,
-        ),
-    ],
-)
-def test_stage(mock_det, scaninfo, stopped, expected_exception):
-    path = "tmp"
-    mock_det.filepath_raw = path
-    with mock.patch.object(
-        mock_det.custom_prepare, "publish_file_location"
-    ) as mock_publish_file_location:
-        mock_det.scaninfo.num_points = scaninfo["num_points"]
-        mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-        mock_det.filewriter.compile_full_filename.return_value = scaninfo["filepath"]
-        mock_det.device_manager.add_device("mokev", value=12.4)
-        mock_det.stopped = stopped
-        with (
-            mock.patch.object(mock_det.custom_prepare, "prepare_data_backend") as mock_data_backend,
-            mock.patch.object(
-                mock_det.custom_prepare, "update_readout_time"
-            ) as mock_update_readout_time,
-        ):
-            mock_det.filepath.set(scaninfo["filepath"]).wait()
-            if expected_exception:
-                with pytest.raises(Exception):
-                    mock_det.timeout = 0.1
-                    mock_det.stage()
-            else:
-                mock_det.stage()
-                mock_data_backend.assert_called_once()
-                mock_update_readout_time.assert_called()
-                # Check _prep_det
-                assert mock_det.cam.num_images.get() == int(
-                    scaninfo["num_points"] * scaninfo["frames_per_trigger"]
-                )
-                assert mock_det.cam.num_frames.get() == 1
-
-                mock_publish_file_location.assert_called_once_with(
-                    done=False, successful=False, metadata={"input_path": path}
-                )
-
-
-def test_pre_scan(mock_det):
-    mock_det.custom_prepare.on_pre_scan()
-    assert mock_det.cam.acquire.get() == 1
-
-
-@pytest.mark.parametrize(
-    "readout_time, expected_value", [(1e-3, 3e-3), (3e-3, 3e-3), (5e-3, 5e-3), (None, 3e-3)]
-)
-def test_update_readout_time(mock_det, readout_time, expected_value):
-    if readout_time is None:
-        mock_det.custom_prepare.update_readout_time()
-        assert mock_det.readout_time == expected_value
-    else:
-        mock_det.scaninfo.readout_time = readout_time
-        mock_det.custom_prepare.update_readout_time()
-        assert mock_det.readout_time == expected_value
-
-
-@pytest.mark.parametrize(
-    "scaninfo",
-    [
-        (
-            {
-                "filepath": "test.h5",
-                "filepath_raw": "test5_raw.h5",
-                "successful": True,
-                "done": False,
-                "scan_id": "123",
-            }
-        ),
-        (
-            {
-                "filepath": "test.h5",
-                "filepath_raw": "test5_raw.h5",
-                "successful": False,
-                "done": True,
-                "scan_id": "123",
-            }
-        ),
-    ],
-)
-def test_publish_file_location(mock_det, scaninfo):
-    mock_det.scaninfo.scan_id = scaninfo["scan_id"]
-    mock_det.filepath.set(scaninfo["filepath"]).wait()
-    mock_det.filepath_raw = scaninfo["filepath_raw"]
-    mock_det.custom_prepare.publish_file_location(
-        done=scaninfo["done"],
-        successful=scaninfo["successful"],
-        metadata={"input_path": scaninfo["filepath_raw"]},
-    )
-    if scaninfo["successful"] is None:
-        msg = messages.FileMessage(
-            file_path=scaninfo["filepath"],
-            done=scaninfo["done"],
-            metadata={"input_path": scaninfo["filepath_raw"]},
-        )
-    else:
-        msg = messages.FileMessage(
-            file_path=scaninfo["filepath"],
-            done=scaninfo["done"],
-            metadata={"input_path": scaninfo["filepath_raw"]},
-            successful=scaninfo["successful"],
-        )
-    expected_calls = [
-        mock.call(
-            MessageEndpoints.public_file(scaninfo["scan_id"], mock_det.name),
-            msg,
-            pipe=mock_det.connector.pipeline.return_value,
-        ),
-        mock.call(
-            MessageEndpoints.file_event(mock_det.name),
-            msg,
-            pipe=mock_det.connector.pipeline.return_value,
-        ),
-    ]
-    assert mock_det.connector.set_and_publish.call_args_list == expected_calls
-
-
-@pytest.mark.parametrize(
-    "requests_state, expected_exception, url_delete, url_put",
-    [
-        (
-            True,
-            False,
-            "http://x12sa-pd-2:8080/stream/pilatus_2",
-            "http://xbl-daq-34:8091/pilatus_2/stop",
-        ),
-        (
-            False,
-            False,
-            "http://x12sa-pd-2:8080/stream/pilatus_2",
-            "http://xbl-daq-34:8091/pilatus_2/stop",
-        ),
-    ],
-)
-def test_stop_detector_backend(mock_det, requests_state, expected_exception, url_delete, url_put):
-    with (
-        mock.patch.object(
-            mock_det.custom_prepare, "send_requests_delete"
-        ) as mock_send_requests_delete,
-        mock.patch.object(mock_det.custom_prepare, "send_requests_put") as mock_send_requests_put,
-    ):
-        instance_delete = mock_send_requests_delete.return_value
-        instance_delete.ok = requests_state
-        instance_put = mock_send_requests_put.return_value
-        instance_put.ok = requests_state
-        if expected_exception:
-            mock_det.custom_prepare.stop_detector_backend()
-            mock_send_requests_delete.assert_called_once_with(url=url_delete)
-            mock_send_requests_put.assert_called_once_with(url=url_put)
-            instance_delete.raise_for_status.called_once()
-            instance_put.raise_for_status.called_once()
-        else:
-            mock_det.custom_prepare.stop_detector_backend()
-            mock_send_requests_delete.assert_called_once_with(url=url_delete)
-            mock_send_requests_put.assert_called_once_with(url=url_put)
-
-
-@pytest.mark.parametrize(
-    "scaninfo, data_msgs, urls, requests_state, expected_exception",
-    [
-        (
-            {
-                "filepath_raw": "pilatus_2.h5",
-                "eacc": "e12345",
-                "scan_number": 1000,
-                "scan_directory": "S00000_00999",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-                "headers": {"Content-Type": "application/json", "Accept": "application/json"},
-            },
-            [
-                {
-                    "source": [
-                        {
-                            "searchPath": "/",
-                            "searchPattern": "glob:*.cbf",
-                            "destinationPath": (
-                                "/sls/X12SA/data/e12345/Data10/pilatus_2/S00000_00999"
-                            ),
-                        }
-                    ]
-                },
-                [
-                    "zmqWriter",
-                    "e12345",
-                    {
-                        "addr": "tcp://x12sa-pd-2:8888",
-                        "dst": ["file"],
-                        "numFrm": 500,
-                        "timeout": 2000,
-                        "ifType": "PULL",
-                        "user": "e12345",
-                    },
-                ],
-                ["zmqWriter", "e12345", {"frmCnt": 500, "timeout": 2000}],
-            ],
-            [
-                "http://x12sa-pd-2:8080/stream/pilatus_2",
-                "http://xbl-daq-34:8091/pilatus_2/run",
-                "http://xbl-daq-34:8091/pilatus_2/wait",
-            ],
-            True,
-            False,
-        ),
-        (
-            {
-                "filepath_raw": "pilatus_2.h5",
-                "eacc": "e12345",
-                "scan_number": 1000,
-                "scan_directory": "S00000_00999",
-                "num_points": 500,
-                "frames_per_trigger": 1,
-                "headers": {"Content-Type": "application/json", "Accept": "application/json"},
-            },
-            [
-                {
-                    "source": [
-                        {
-                            "searchPath": "/",
-                            "searchPattern": "glob:*.cbf",
-                            "destinationPath": (
-                                "/sls/X12SA/data/e12345/Data10/pilatus_2/S00000_00999"
-                            ),
-                        }
-                    ]
-                },
-                [
-                    "zmqWriter",
-                    "e12345",
-                    {
-                        "addr": "tcp://x12sa-pd-2:8888",
-                        "dst": ["file"],
-                        "numFrm": 500,
-                        "timeout": 2000,
-                        "ifType": "PULL",
-                        "user": "e12345",
-                    },
-                ],
-                ["zmqWriter", "e12345", {"frmCnt": 500, "timeout": 2000}],
-            ],
-            [
-                "http://x12sa-pd-2:8080/stream/pilatus_2",
-                "http://xbl-daq-34:8091/pilatus_2/run",
-                "http://xbl-daq-34:8091/pilatus_2/wait",
-            ],
-            False,  # return of res.ok is False!
-            True,
-        ),
-    ],
-)
-def test_prep_file_writer(mock_det, scaninfo, data_msgs, urls, requests_state, expected_exception):
-    with (
-        mock.patch.object(mock_det.custom_prepare, "close_file_writer") as mock_close_file_writer,
-        mock.patch.object(mock_det.custom_prepare, "stop_file_writer") as mock_stop_file_writer,
-        mock.patch.object(mock_det, "filewriter") as mock_filewriter,
-        mock.patch.object(mock_det.custom_prepare, "create_directory") as mock_create_directory,
-        mock.patch.object(mock_det.custom_prepare, "send_requests_put") as mock_send_requests_put,
-    ):
-        mock_det.scaninfo.scan_number = scaninfo["scan_number"]
-        mock_det.scaninfo.num_points = scaninfo["num_points"]
-        mock_det.scaninfo.frames_per_trigger = scaninfo["frames_per_trigger"]
-        mock_det.scaninfo.username = scaninfo["eacc"]
-        mock_filewriter.compile_full_filename.return_value = scaninfo["filepath_raw"]
-        mock_filewriter.get_scan_directory.return_value = scaninfo["scan_directory"]
-        instance = mock_send_requests_put.return_value
-        instance.ok = requests_state
-        instance.raise_for_status.side_effect = Exception
-
-        if expected_exception:
-            with pytest.raises(Exception):
-                mock_det.timeout = 0.1
-                mock_det.custom_prepare.prepare_data_backend()
-                mock_close_file_writer.assert_called_once()
-                mock_stop_file_writer.assert_called_once()
-                instance.raise_for_status.assert_called_once()
-        else:
-            mock_det.custom_prepare.prepare_data_backend()
-
-            mock_close_file_writer.assert_called_once()
-            mock_stop_file_writer.assert_called_once()
-
-            # Assert values set on detector
-            assert mock_det.cam.file_path.get() == "/dev/shm/zmq/"
-            assert (
-                mock_det.cam.file_name.get()
-                == f"{scaninfo['eacc']}_2_{scaninfo['scan_number']:05d}"
-            )
-            assert mock_det.cam.auto_increment.get() == 1
-            assert mock_det.cam.file_number.get() == 0
-            assert mock_det.cam.file_format.get() == 0
-            assert mock_det.cam.file_template.get() == "%s%s_%5.5d.cbf"
-            # Remove last / from destinationPath
-            mock_create_directory.assert_called_once_with(
-                os.path.join(data_msgs[0]["source"][0]["destinationPath"])
-            )
-            assert mock_send_requests_put.call_count == 3
-
-            calls = [
-                mock.call(url=url, data=data_msg, headers=scaninfo["headers"])
-                for url, data_msg in zip(urls, data_msgs)
-            ]
-            for call, mock_call in zip(calls, mock_send_requests_put.call_args_list):
-                assert call == mock_call
-
-
-def test_complete(mock_det):
-    path = "tmp"
-    mock_det.filepath_raw = path
-    with (
-        mock.patch.object(mock_det.custom_prepare, "finished") as mock_finished,
-        mock.patch.object(
-            mock_det.custom_prepare, "publish_file_location"
-        ) as mock_publish_file_location,
-    ):
-        mock_det.complete()
-        assert mock_finished.call_count == 1
-        call = mock.call(done=True, successful=True, metadata={"input_path": path})
-        assert mock_publish_file_location.call_args == call
-
-
-def test_stop(mock_det):
-    with (
-        mock.patch.object(mock_det.custom_prepare, "stop_detector") as mock_stop_det,
-        mock.patch.object(mock_det.custom_prepare, "stop_file_writer") as mock_stop_file_writer,
-        mock.patch.object(mock_det.custom_prepare, "close_file_writer") as mock_close_file_writer,
-    ):
-        mock_det.stop()
-        mock_stop_det.assert_called_once()
-        mock_stop_file_writer.assert_called_once()
-        mock_close_file_writer.assert_called_once()
-        assert mock_det.stopped is True
-
-
-@pytest.mark.parametrize(
-    "stopped, mcs_stage_state, expected_exception",
-    [
-        (False, ophyd.Staged.no, False),
-        (True, ophyd.Staged.no, True),
-        (False, ophyd.Staged.yes, True),
-    ],
-)
-def test_finished(mock_det, stopped, mcs_stage_state, expected_exception):
-    with (
-        mock.patch.object(mock_det, "device_manager") as mock_dm,
-        mock.patch.object(mock_det.custom_prepare, "stop_file_writer") as mock_stop_file_friter,
-        mock.patch.object(mock_det.custom_prepare, "stop_detector") as mock_stop_det,
-        mock.patch.object(mock_det.custom_prepare, "close_file_writer") as mock_close_file_writer,
-    ):
-        mock_dm.devices.mcs.obj._staged = mcs_stage_state
-        mock_det.stopped = stopped
-        if expected_exception:
-            with pytest.raises(Exception):
-                mock_det.timeout = 0.1
-                mock_det.custom_prepare.finished()
-                assert mock_det.stopped is stopped
-                mock_stop_file_friter.assert_called()
-                mock_stop_det.assert_called_once()
-                mock_close_file_writer.assert_called_once()
-        else:
-            mock_det.custom_prepare.finished()
-            if stopped:
-                assert mock_det.stopped is stopped
-
-            mock_stop_file_friter.assert_called()
-            mock_stop_det.assert_called_once()
-            mock_close_file_writer.assert_called_once()