dls-dodal 1.48.0__py3-none-any.whl → 1.50.0__py3-none-any.whl

dodal/beamlines/k11.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+from ophyd_async.epics.motor import Motor
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    set_path_provider,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.visit import RemoteDirectoryServiceClient, StaticVisitPathProvider
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+beamline = get_beamline_name("k11")
+PREFIX = BeamlinePrefix(beamline)
+set_log_beamline(beamline)
+set_utils_beamline(beamline)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        beamline,
+        Path("/dls/k11/data/2025/cm40627-3"),
+        client=RemoteDirectoryServiceClient("https://k11-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def kb_x() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:X")
+
+
+@device_factory()
+def kb_y() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:Y")

dodal/common/beamlines/device_helpers.py

@@ -3,6 +3,7 @@ from dodal.devices.slits import Slits
 from dodal.utils import skip_device
 
 HDF5_SUFFIX = "HDF5:"
+TIFF_SUFFIX = "TIFF:"
 CAM_SUFFIX = "CAM:"
 DET_SUFFIX = "DET:"
 

dodal/devices/apple2_undulator.py

@@ -1,18 +1,19 @@
 import abc
 import asyncio
 from dataclasses import dataclass
+from math import isclose
 from typing import Any, Generic, TypeVar
 
 import numpy as np
 from bluesky.protocols import Movable
 from ophyd_async.core import (
     AsyncStatus,
-    Reference,
     SignalR,
     SignalW,
     StandardReadable,
     StandardReadableFormat,
     StrictEnum,
+    derived_signal_rw,
     soft_signal_r_and_setter,
     wait_for_value,
 )
@@ -23,6 +24,8 @@ from dodal.log import LOGGER
 
 T = TypeVar("T")
 
+DEFAULT_MOTOR_MIN_TIMEOUT = 10
+
 
 class UndulatorGateStatus(StrictEnum):
     OPEN = "Open"
@@ -68,8 +71,7 @@ class LookupTableEntries(BaseModel):
 
 
 class Lookuptable(RootModel):
-    """
-    BaseModel class for the lookup table.
+    """BaseModel class for the lookup table.
     Apple2 lookup table should be in this format.
 
     {mode: {'Energies': {Any: {'Low': float,
@@ -87,6 +89,16 @@ class Lookuptable(RootModel):
     root: dict[str, LookupTableEntries]
 
 
+class Pol(StrictEnum):
+    NONE = "None"
+    LH = "lh"
+    LV = "lv"
+    PC = "pc"
+    NC = "nc"
+    LA = "la"
+    LH3 = "lh3"
+
+
 ROW_PHASE_MOTOR_TOLERANCE = 0.004
 MAXIMUM_ROW_PHASE_MOTOR_POSITION = 24.0
 MAXIMUM_GAP_MOTOR_POSITION = 100
@@ -98,7 +110,7 @@ async def estimate_motor_timeout(
     vel = await velocity.get_value()
     cur_pos = await curr_pos.get_value()
     target_pos = float(await setpoint.get_value())
-    return abs((target_pos - cur_pos) * 2.0 / vel) + 1
+    return abs((target_pos - cur_pos) * 2.0 / vel) + DEFAULT_MOTOR_MIN_TIMEOUT
 
 
 class SafeUndulatorMover(StandardReadable, Movable[T], Generic[T]):
@@ -216,11 +228,10 @@ class UndulatorPhaseMotor(StandardReadable):
         """
         fullPV = f"{prefix}BL{infix}"
         self.user_setpoint = epics_signal_w(str, fullPV + "SET")
-        self.user_setpoint_demand_readback = epics_signal_r(float, fullPV + "DMD")
-
+        self.user_setpoint_readback = epics_signal_r(float, fullPV + "DMD")
         fullPV = fullPV + "MTR"
         with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
-            self.user_setpoint_readback = epics_signal_r(float, fullPV + ".RBV")
+            self.user_readback = epics_signal_r(float, fullPV + ".RBV")
 
         with self.add_children_as_readables(StandardReadableFormat.CONFIG_SIGNAL):
             self.motor_egu = epics_signal_r(str, fullPV + ".EGU")
@@ -282,20 +293,24 @@ class UndulatorPhaseAxes(SafeUndulatorMover[Apple2PhasesVal]):
         timeouts = await asyncio.gather(
             *[
                 estimate_motor_timeout(
-                    axis.user_setpoint_demand_readback,
                     axis.user_setpoint_readback,
+                    axis.user_readback,
                     axis.velocity,
                 )
                 for axis in axes
             ]
         )
-        return np.max(timeouts)
+        """A 2.0 multiplier is required to prevent premature motor timeouts in phase
+        axes as it is a master-slave system, where the slave's movement,
+        being dependent on the master, can take up to twice as long to complete.
+        """
+        return np.max(timeouts) * 2.0
 
 
 class UndulatorJawPhase(SafeUndulatorMover[float]):
     """
     A JawPhase movable, this is use for moving the jaw phase which is use to control the
-    linear arbitrary polarisation but only one some of the beamline.
+    linear arbitrary polarisation but only on some of the beamline.
     """
 
     def __init__(
@@ -321,23 +336,70 @@ class UndulatorJawPhase(SafeUndulatorMover[float]):
         Get motor speed, current position and target position to calculate required timeout.
         """
         return await estimate_motor_timeout(
-            self.jaw_phase.user_setpoint_demand_readback,
             self.jaw_phase.user_setpoint_readback,
+            self.jaw_phase.user_readback,
             self.jaw_phase.velocity,
         )
 
 
-class Apple2(StandardReadable, Movable):
+class Apple2(abc.ABC, StandardReadable, Movable):
     """
-    Apple 2 ID/undulator has 4 extra degrees of freedom compare to the standard Undulator,
-     each bank of magnet can move independently to each other,
-     which allow the production of different x-ray polarisation as well as energy.
-     This type of ID is use on I10, I21, I09, I17 and I06 for soft x-ray.
+    Apple2 Undulator Device
+
+    The `Apple2` class represents an Apple 2 insertion device (undulator) used in synchrotron beamlines.
+    This device provides additional degrees of freedom compared to standard undulators, allowing independent
+    movement of magnet banks to produce X-rays with various polarisations and energies.
+
+    The class is designed to manage the undulator's gap, phase motors, and polarisation settings, while
+    abstracting hardware interactions and providing a high-level interface for beamline operations.
+
 
     A pair of look up tables are needed to provide the conversion between motor position
-     and energy.
-    This conversion (update_lookuptable) and the way the id move (set) are two abstract
-     methods that are beamline specific and need to be implemented.
+    and energy.
+
+    Attributes
+    ----------
+    gap : UndulatorGap
+        The gap control device for the undulator.
+    phase : UndulatorPhaseAxes
+        The phase control device, consisting of four phase motors.
+    energy : SignalR
+        A soft signal for the current energy readback.
+    polarisation_setpoint : SignalR
+        A soft signal for the polarisation setpoint.
+    polarisation : SignalRW
+        A hardware-backed signal for polarisation readback and control.
+    lookup_tables : dict
+        A dictionary storing lookup tables for gap and phase motor positions, used for energy and polarisation conversion.
+    _available_pol : list
+        A list of available polarisations supported by the device.
+
+    Abstract Methods
+    ----------------
+    set(value: float) -> None
+        Abstract method to set motor positions for a given energy and polarisation.
+    update_lookuptable() -> None
+        Abstract method to load and validate lookup tables from external sources.
+
+    Methods
+    -------
+    _set_pol_setpoint(pol: Pol) -> None
+        Sets the polarisation setpoint without moving hardware.
+    determine_phase_from_hardware(...) -> tuple[Pol, float]
+        Determines the polarisation and phase value based on motor positions.
+
+    Notes
+    -----
+    - This class requires beamline-specific implementations of the abstract methods.
+    - The lookup tables must follow the `Lookuptable` format and be validated before use.
+    - The device supports multiple polarisation modes, including linear horizontal (LH), linear vertical (LV),
+      positive circular (PC), negative circular (NC), and linear arbitrary (LA).
+
+    For more detail see
+    `UML </_images/apple2_design.png>`__ for detail.
+
+    .. figure:: /explanations/umls/apple2_design.png
+
     """
 
     def __init__(
@@ -348,129 +410,198 @@ class Apple2(StandardReadable, Movable):
         name: str = "",
     ) -> None:
         """
+
         Parameters
         ----------
-        id_gap:
-            An UndulatorGap device.
-        id_phase:
-            An UndulatorPhaseAxes device.
-        prefix:
-            Not in use but needed for device_instantiation.
-        name:
-            Name of the device.
+        id_gap: An UndulatorGap device.
+        id_phase: An UndulatorPhaseAxes device.
+        prefix: Not in use but needed for device_instantiation.
+        name: Name of the device.
         """
         super().__init__(name)
 
         # Attributes are set after super call so they are not renamed to
         # <name>-undulator, etc.
-        self.gap = Reference(id_gap)
-        self.phase = Reference(id_phase)
+        self.gap = id_gap
+        self.phase = id_phase
 
         with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
-            # Store the polarisation for readback.
-            self.polarisation, self._polarisation_set = soft_signal_r_and_setter(
-                str, initial_value=None
-            )
             # Store the set energy for readback.
-            self.energy, self._energy_set = soft_signal_r_and_setter(
+            self.energy, self._set_energy_rbv = soft_signal_r_and_setter(
                 float, initial_value=None
             )
+
+        # Store the polarisation for setpoint. And provide readback for LH3.
+        # LH3 is a special case as it is indistinguishable from LH in the hardware.
+        self.polarisation_setpoint, self._polarisation_setpoint_set = (
+            soft_signal_r_and_setter(Pol)
+        )
         # This store two lookup tables, Gap and Phase in the Lookuptable format
         self.lookup_tables: dict[str, dict[str | None, dict[str, dict[str, Any]]]] = {
             "Gap": {},
             "Phase": {},
         }
-        # List of available polarisation according to the lookup table.
+        # Hardware backed read/write for polarisation.
+        self.polarisation = derived_signal_rw(
+            raw_to_derived=self._read_pol,
+            set_derived=self._set_pol,
+            pol=self.polarisation_setpoint,
+            top_outer=self.phase.top_outer.user_readback,
+            top_inner=self.phase.top_inner.user_readback,
+            btm_inner=self.phase.btm_inner.user_readback,
+            btm_outer=self.phase.btm_outer.user_readback,
+            gap=id_gap.user_readback,
+        )
+
         self._available_pol = []
-        # The polarisation state of the id that are use for internal checking before setting.
-        self._pol = None
         """
         Abstract method that run at start up to load lookup tables into  self.lookup_tables
-         and set available_pol.
+        and set available_pol.
         """
         self.update_lookuptable()
 
-    @property
-    def pol(self):
-        return self._pol
+    def _set_pol_setpoint(self, pol: Pol) -> None:
+        """Set the polarisation setpoint without moving hardware. The polarisation
+        setpoint is used to determine the gap and phase motor positions when
+        setting the energy/polarisation of the undulator."""
+        self._polarisation_setpoint_set(pol)
 
-    @pol.setter
-    def pol(self, pol: str):
-        # This set the polarisation but does not actually move hardware.
-        if pol in self._available_pol:
-            self._pol = pol
-        else:
-            raise ValueError(
-                f"Polarisation {pol} is not available:"
-                + f"/n Polarisations available:  {self._available_pol}"
+    async def _set_pol(
+        self,
+        value: Pol,
+    ) -> None:
+        # This changes the pol setpoint and then changes polarisation via set energy.
+        self._set_pol_setpoint(value)
+        await self.set(await self.energy.get_value())
+
+    @abc.abstractmethod
+    @AsyncStatus.wrap
+    async def set(self, value: float) -> None:
+        """
+        Set should be in energy units, this will set the energy of the ID by setting the
+        gap and phase motors to the correct position for the given energy
+        and polarisation.
+        This method should be implemented by the beamline specific ID class as the
+        motor positions will be different for each beamline depending on the
+        undulator design and the lookup table used.
+        _set can be used to set the motor positions for the given energy and
+        polarisation provided that all motors can be moved at the same time.
+
+        Examples
+        --------
+        >>> RE( id.set(888.0)) # This will set the ID to 888 eV
+        >>> RE(scan([detector], id,600,700,100)) # This will scan the ID from 600 to 700 eV in 100 steps.
+        """
+
+    def _read_pol(
+        self,
+        pol: Pol,
+        top_outer: float,
+        top_inner: float,
+        btm_inner: float,
+        btm_outer: float,
+        gap: float,
+    ) -> Pol:
+        LOGGER.info(
+            f"Reading polarisation setpoint from hardware: "
+            f"top_outer={top_outer}, top_inner={top_inner}, "
+            f"btm_inner={btm_inner}, btm_outer={btm_outer}, gap={gap}."
+        )
+
+        read_pol, _ = self.determine_phase_from_hardware(
+            top_outer, top_inner, btm_inner, btm_outer, gap
+        )
+        # LH3 is indistinguishable from LH see determine_phase_from_hardware's docString
+        # so we return LH3 if the setpoint is LH3 and the readback is LH.
+        if pol == Pol.LH3 and read_pol == Pol.LH:
+            LOGGER.info(
+                "The hardware cannot distinguish between LH and LH3."
+                " Returning the last commanded polarisation value"
             )
+            return Pol.LH3
+
+        return read_pol
 
     async def _set(self, value: Apple2Val, energy: float) -> None:
         """
-        Check ID is in a movable state and set all the demand value before moving.
-
+        Check ID is in a movable state and set all the demand value before moving them
+        all at the same time. This should be modified by the beamline specific ID class
+        , if the ID motors has to move in a specific order.
         """
 
         # Only need to check gap as the phase motors share both fault and gate with gap.
-        await self.gap().raise_if_cannot_move()
+        await self.gap.raise_if_cannot_move()
         await asyncio.gather(
-            self.phase().top_outer.user_setpoint.set(value=value.top_outer),
-            self.phase().top_inner.user_setpoint.set(value=value.top_inner),
-            self.phase().btm_inner.user_setpoint.set(value=value.btm_inner),
-            self.phase().btm_outer.user_setpoint.set(value=value.btm_outer),
-            self.gap().user_setpoint.set(value=value.gap),
+            self.phase.top_outer.user_setpoint.set(value=value.top_outer),
+            self.phase.top_inner.user_setpoint.set(value=value.top_inner),
+            self.phase.btm_inner.user_setpoint.set(value=value.btm_inner),
+            self.phase.btm_outer.user_setpoint.set(value=value.btm_outer),
+            self.gap.user_setpoint.set(value=value.gap),
         )
         timeout = np.max(
-            await asyncio.gather(self.gap().get_timeout(), self.phase().get_timeout())
+            await asyncio.gather(self.gap.get_timeout(), self.phase.get_timeout())
         )
         LOGGER.info(
-            f"Moving f{self.name} energy and polorisation to {energy}, {self.pol}"
+            f"Moving f{self.name} energy and polorisation to {energy}, {await self.polarisation.get_value()}"
             + f"with motor position {value}, timeout = {timeout}"
         )
-
         await asyncio.gather(
-            self.gap().set_move.set(value=1, timeout=timeout),
-            self.phase().set_move.set(value=1, timeout=timeout),
-        )
-        await wait_for_value(
-            self.gap().gate, UndulatorGateStatus.CLOSE, timeout=timeout
+            self.gap.set_move.set(value=1, wait=False, timeout=timeout),
+            self.phase.set_move.set(value=1, wait=False, timeout=timeout),
         )
-        self._energy_set(energy)  # Update energy for after move for readback.
+        await wait_for_value(self.gap.gate, UndulatorGateStatus.CLOSE, timeout=timeout)
+        self._set_energy_rbv(energy)  # Update energy after move for readback.
 
-    def _get_id_gap_phase(self, energy: float) -> tuple[float, float]:
+    async def _get_id_gap_phase(self, energy: float) -> tuple[float, float]:
         """
         Converts energy and polarisation to gap and phase.
         """
-        gap_poly = self._get_poly(
+        gap_poly = await self._get_poly(
             lookup_table=self.lookup_tables["Gap"], new_energy=energy
         )
-        phase_poly = self._get_poly(
+        phase_poly = await self._get_poly(
             lookup_table=self.lookup_tables["Phase"], new_energy=energy
         )
         return gap_poly(energy), phase_poly(energy)
 
-    def _get_poly(
+    async def _get_poly(
         self,
         new_energy: float,
         lookup_table: dict[str | None, dict[str, dict[str, Any]]],
     ) -> np.poly1d:
         """
         Get the correct polynomial for a given energy form lookuptable
-         for any given polarisation.
+        for the current polarisation setpoint.
+        Parameters
+        ----------
+        new_energy : float
+            The energy in eV for which the polynomial is requested.
+        lookup_table : dict[str | None, dict[str, dict[str, Any]]]
+            The lookup table containing polynomial coefficients for different energies
+            and polarisations.
+        Returns
+        -------
+        np.poly1d
+            The polynomial coefficients for the requested energy and polarisation.
+        Raises
+        ------
+        ValueError
+            If the requested energy is outside the limits defined in the lookup table
+            or if no polynomial coefficients are found for the requested energy.
         """
-
+        pol = await self.polarisation_setpoint.get_value()
         if (
-            new_energy < lookup_table[self.pol]["Limit"]["Minimum"]
-            or new_energy > lookup_table[self.pol]["Limit"]["Maximum"]
+            new_energy < lookup_table[pol]["Limit"]["Minimum"]
+            or new_energy > lookup_table[pol]["Limit"]["Maximum"]
         ):
             raise ValueError(
                 "Demanding energy must lie between {} and {} eV!".format(
-                    lookup_table[self.pol]["Limit"]["Minimum"],
-                    lookup_table[self.pol]["Limit"]["Maximum"],
+                    lookup_table[pol]["Limit"]["Minimum"],
+                    lookup_table[pol]["Limit"]["Maximum"],
                 )
             )
         else:
-            for energy_range in lookup_table[self.pol]["Energies"].values():
+            for energy_range in lookup_table[pol]["Energies"].values():
                 if (
                     new_energy >= energy_range["Low"]
                     and new_energy < energy_range["High"]
@@ -492,87 +623,77 @@ class Apple2(StandardReadable, Movable):
 
         """
 
-    async def determinePhaseFromHardware(self) -> tuple[str | None, float]:
+    def determine_phase_from_hardware(
+        self,
+        top_outer: float,
+        top_inner: float,
+        btm_inner: float,
+        btm_outer: float,
+        gap: float,
+    ) -> tuple[Pol, float]:
         """
-        Try to determine polarisation and phase value using row phase motor position pattern.
+        Determine polarisation and phase value using motor position patterns.
         However there is no way to return lh3 polarisation or higher harmonic setting.
         (May be for future one can use the inverse poly to work out the energy and try to match it with the current energy
         to workout the polarisation but during my test the inverse poly is too unstable for general use.)
         """
-        top_outer = await self.phase().top_outer.user_setpoint_readback.get_value()
-        top_inner = await self.phase().top_inner.user_setpoint_readback.get_value()
-        btm_inner = await self.phase().btm_inner.user_setpoint_readback.get_value()
-        btm_outer = await self.phase().btm_outer.user_setpoint_readback.get_value()
-        gap = await self.gap().user_readback.get_value()
         if gap > MAXIMUM_GAP_MOTOR_POSITION:
             raise RuntimeError(
                 f"{self.name} is not in use, close gap or set polarisation to use this ID"
             )
 
         if all(
-            motor_position_equal(x, 0.0)
+            isclose(x, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
             for x in [top_outer, top_inner, btm_inner, btm_outer]
         ):
-            # Linear Horizontal
-            polarisation = "lh"
-            phase = 0.0
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: LH (Linear Horizontal).")
+            return Pol.LH, 0.0
         if (
-            motor_position_equal(top_outer, MAXIMUM_ROW_PHASE_MOTOR_POSITION)
-            and motor_position_equal(top_inner, 0.0)
-            and motor_position_equal(btm_inner, MAXIMUM_ROW_PHASE_MOTOR_POSITION)
-            and motor_position_equal(btm_outer, 0.0)
+            isclose(
+                top_outer,
+                MAXIMUM_ROW_PHASE_MOTOR_POSITION,
+                abs_tol=ROW_PHASE_MOTOR_TOLERANCE,
+            )
+            and isclose(top_inner, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(
+                btm_inner,
+                MAXIMUM_ROW_PHASE_MOTOR_POSITION,
+                abs_tol=ROW_PHASE_MOTOR_TOLERANCE,
+            )
+            and isclose(btm_outer, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
         ):
-            # Linear Vertical
-            polarisation = "lv"
-            phase = MAXIMUM_ROW_PHASE_MOTOR_POSITION
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: LV (Linear Vertical).")
+            return Pol.LV, MAXIMUM_ROW_PHASE_MOTOR_POSITION
         if (
-            motor_position_equal(top_outer, btm_inner)
+            isclose(top_outer, btm_inner, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
             and top_outer > 0.0
-            and motor_position_equal(top_inner, 0.0)
-            and motor_position_equal(btm_outer, 0.0)
+            and isclose(top_inner, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(btm_outer, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
         ):
-            # Positive Circular
-            polarisation = "pc"
-            phase = top_outer
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: PC (Positive Circular).")
+            return Pol.PC, top_outer
         if (
-            motor_position_equal(top_outer, btm_inner)
+            isclose(top_outer, btm_inner, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
             and top_outer < 0.0
-            and motor_position_equal(top_inner, 0.0)
-            and motor_position_equal(btm_outer, 0.0)
+            and isclose(top_inner, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(btm_outer, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
         ):
-            # Negative Circular
-            polarisation = "nc"
-            phase = top_outer
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: NC (Negative Circular).")
+            return Pol.NC, top_outer
         if (
-            motor_position_equal(top_outer, -btm_inner)
-            and motor_position_equal(top_inner, 0.0)
-            and motor_position_equal(btm_outer, 0.0)
+            isclose(top_outer, -btm_inner, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(top_inner, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(btm_outer, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
         ):
-            # Positive Linear Arbitrary
-            polarisation = "la"
-            phase = top_outer
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: LA (Positive Linear Arbitrary).")
+            return Pol.LA, top_outer
         if (
-            motor_position_equal(top_inner, -btm_outer)
-            and motor_position_equal(top_outer, 0.0)
-            and motor_position_equal(btm_inner, 0.0)
+            isclose(top_inner, -btm_outer, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(top_outer, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
+            and isclose(btm_inner, 0.0, abs_tol=ROW_PHASE_MOTOR_TOLERANCE)
         ):
-            # Negative Linear Arbitrary
-            polarisation = "la"
-            phase = top_inner
-            return polarisation, phase
-        # UNKNOWN default
-        polarisation = None
-        phase = 0.0
-        return (polarisation, phase)
-
+            LOGGER.info("Determined polarisation: LA (Negative Linear Arbitrary).")
+            return Pol.LA, top_inner
 
-def motor_position_equal(a, b) -> bool:
-    """
-    Check motor is within tolerance.
-    """
-    return abs(a - b) < ROW_PHASE_MOTOR_TOLERANCE
+        LOGGER.warning("Unable to determine polarisation. Defaulting to NONE.")
+        return Pol.NONE, 0.0

dodal/devices/b16/detector.py

@@ -0,0 +1,34 @@
+from ophyd_async.epics.adcore import (
+    ADBaseController,
+    ADBaseIO,
+    ADTIFFWriter,
+    AreaDetector,
+)
+
+from dodal.common.beamlines.beamline_utils import get_path_provider
+from dodal.common.beamlines.device_helpers import CAM_SUFFIX, TIFF_SUFFIX
+
+
+class ConstantDeadTimeController(ADBaseController):
+    def __init__(self, driver: ADBaseIO, deadtime: float):
+        super().__init__(driver)
+        self.deadtime = deadtime
+
+    def get_deadtime(self, exposure: float | None) -> float:
+        return self.deadtime
+
+
+def software_triggered_tiff_area_detector(prefix: str, deadtime: float = 0.0):
+    """
+    Wrapper for AreaDetector with fixed dead time (defaulted to 0)
+    and a TIFF file writer.
+    Most detectors in B16 could be configured like this
+    """
+    return AreaDetector(
+        writer=ADTIFFWriter.with_io(
+            prefix=prefix, path_provider=get_path_provider(), fileio_suffix=TIFF_SUFFIX
+        ),
+        controller=ConstantDeadTimeController(
+            driver=ADBaseIO(prefix + CAM_SUFFIX), deadtime=deadtime
+        ),
+    )