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

dodal/devices/electron_analyser/types.py

@@ -1,3 +1,5 @@
+from ophyd_async.core import StrictEnum, SupersetEnum
+
 from dodal.devices.electron_analyser.abstract.base_driver_io import (
     AbstractAnalyserDriverIO,
 )
@@ -18,15 +20,29 @@ from dodal.devices.electron_analyser.vgscienta.detector import (
     VGScientaDetector,
 )
 
-ElectronAnalyserDetectorImpl = VGScientaDetector | SpecsDetector
-ElectronAnalyserDriverImpl = VGScientaAnalyserDriverIO | SpecsAnalyserDriverIO
+AnyAcqMode = StrictEnum
+AnyLensMode = SupersetEnum | StrictEnum
+
+# Electron analyser types that encompasses all implementations, useful for tests and
+# plans
+ElectronAnalyserDetectorImpl = (
+    VGScientaDetector[AnyLensMode] | SpecsDetector[AnyLensMode]
+)
+ElectronAnalyserDriverImpl = (
+    VGScientaAnalyserDriverIO[AnyLensMode] | SpecsAnalyserDriverIO[AnyLensMode]
+)
 
+# Short hand the type so less verbose
+AbstractBaseRegion = AbstractBaseRegion[AnyAcqMode, AnyLensMode]
+
+# Generic electron analyser types that supports full typing with the abstract classes.
 GenericElectronAnalyserDetector = ElectronAnalyserDetector[
-    AbstractAnalyserDriverIO[AbstractBaseRegion],
-    AbstractBaseSequence,
+    AbstractAnalyserDriverIO[AbstractBaseRegion, AnyAcqMode, AnyLensMode],
+    AbstractBaseSequence[AbstractBaseRegion, AnyLensMode],
     AbstractBaseRegion,
 ]
 
 GenericElectronAnalyserRegionDetector = ElectronAnalyserRegionDetector[
-    AbstractAnalyserDriverIO[AbstractBaseRegion], AbstractBaseRegion
+    AbstractAnalyserDriverIO[AbstractBaseRegion, AnyAcqMode, AnyLensMode],
+    AbstractBaseRegion,
 ]

dodal/devices/electron_analyser/vgscienta/detector.py

@@ -1,3 +1,9 @@
+from collections.abc import Mapping
+from typing import Generic
+
+from ophyd_async.core import SignalR
+
+from dodal.devices.electron_analyser.abstract.base_region import TLensMode
 from dodal.devices.electron_analyser.detector import (
     ElectronAnalyserDetector,
 )
@@ -12,11 +18,20 @@ from dodal.devices.electron_analyser.vgscienta.region import (
 
 class VGScientaDetector(
     ElectronAnalyserDetector[
-        VGScientaAnalyserDriverIO,
-        VGScientaSequence,
-        VGScientaRegion,
-    ]
+        VGScientaAnalyserDriverIO[TLensMode],
+        VGScientaSequence[TLensMode],
+        VGScientaRegion[TLensMode],
+    ],
+    Generic[TLensMode],
 ):
-    def __init__(self, prefix: str, name: str = ""):
-        driver = VGScientaAnalyserDriverIO(prefix)
-        super().__init__(prefix, VGScientaSequence, driver, name)
+    def __init__(
+        self,
+        prefix: str,
+        lens_mode_type: type[TLensMode],
+        energy_sources: Mapping[str, SignalR[float]],
+        name: str = "",
+    ):
+        driver = VGScientaAnalyserDriverIO[TLensMode](
+            prefix, lens_mode_type, energy_sources
+        )
+        super().__init__(VGScientaSequence[lens_mode_type], driver, name)

dodal/devices/electron_analyser/vgscienta/driver_io.py

@@ -1,4 +1,6 @@
 import asyncio
+from collections.abc import Mapping
+from typing import Generic
 
 import numpy as np
 from ophyd_async.core import (
@@ -13,6 +15,7 @@ from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
 from dodal.devices.electron_analyser.abstract.base_driver_io import (
     AbstractAnalyserDriverIO,
 )
+from dodal.devices.electron_analyser.abstract.base_region import TLensMode
 from dodal.devices.electron_analyser.util import to_kinetic_energy
 from dodal.devices.electron_analyser.vgscienta.enums import AcquisitionMode
 from dodal.devices.electron_analyser.vgscienta.region import (
@@ -21,8 +24,17 @@ from dodal.devices.electron_analyser.vgscienta.region import (
 )
 
 
-class VGScientaAnalyserDriverIO(AbstractAnalyserDriverIO[VGScientaRegion]):
-    def __init__(self, prefix: str, name: str = "") -> None:
+class VGScientaAnalyserDriverIO(
+    AbstractAnalyserDriverIO[VGScientaRegion, AcquisitionMode, TLensMode],
+    Generic[TLensMode],
+):
+    def __init__(
+        self,
+        prefix: str,
+        lens_mode_type: type[TLensMode],
+        energy_sources: Mapping[str, SignalR[float]],
+        name: str = "",
+    ) -> None:
         with self.add_children_as_readables(StandardReadableFormat.CONFIG_SIGNAL):
             # Used for setting up region data acquisition.
             self.centre_energy = epics_signal_rw(float, prefix + "CENTRE_ENERGY")
@@ -32,14 +44,10 @@ class VGScientaAnalyserDriverIO(AbstractAnalyserDriverIO[VGScientaRegion]):
             self.y_channel_size = epics_signal_rw(int, prefix + "SizeY")
             self.detector_mode = epics_signal_rw(DetectorMode, prefix + "DETECTOR_MODE")
 
-        with self.add_children_as_readables():
-            # Used to read detector data after acqusition.
-            self.external_io = epics_signal_r(Array1D[np.float64], prefix + "EXTIO")
-
-        super().__init__(prefix, AcquisitionMode, name)
+        super().__init__(prefix, AcquisitionMode, lens_mode_type, energy_sources, name)
 
     @AsyncStatus.wrap
-    async def set(self, region: VGScientaRegion):
+    async def set(self, region: VGScientaRegion[TLensMode]):
         await super().set(region)
 
         excitation_energy = await self.excitation_energy.get_value()

dodal/devices/electron_analyser/vgscienta/region.py

@@ -1,4 +1,5 @@
 import uuid
+from typing import Generic
 
 from pydantic import Field
 
@@ -6,6 +7,7 @@ from dodal.devices.electron_analyser.abstract.base_region import (
     AbstractBaseRegion,
     AbstractBaseSequence,
     JavaToPythonModel,
+    TLensMode,
 )
 from dodal.devices.electron_analyser.vgscienta.enums import (
     AcquisitionMode,
@@ -14,9 +16,11 @@ from dodal.devices.electron_analyser.vgscienta.enums import (
 )
 
 
-class VGScientaRegion(AbstractBaseRegion[AcquisitionMode]):
+class VGScientaRegion(
+    AbstractBaseRegion[AcquisitionMode, TLensMode], Generic[TLensMode]
+):
     # Override defaults of base region class
-    lens_mode: str = "Angular45"
+    lens_mode: TLensMode
     pass_energy: int = 5
     acquisition_mode: AcquisitionMode = AcquisitionMode.SWEPT
     low_energy: float = 8.0
@@ -28,7 +32,6 @@ class VGScientaRegion(AbstractBaseRegion[AcquisitionMode]):
     fix_energy: float = 9.0
     total_steps: float = 13.0
     total_time: float = 13.0
-    exposure_time: float = 1.0
     first_x_channel: int = 1
     last_x_channel: int = 1000
     first_y_channel: int = 101
@@ -49,15 +52,17 @@ class VGScientaExcitationEnergySource(JavaToPythonModel):
     value: float = 0
 
 
-class VGScientaSequence(AbstractBaseSequence[VGScientaRegion]):
+class VGScientaSequence(
+    AbstractBaseSequence[VGScientaRegion, TLensMode], Generic[TLensMode]
+):
     element_set: str = Field(default="Unknown")
     excitation_energy_sources: list[VGScientaExcitationEnergySource] = Field(
         default_factory=lambda: []
     )
-    regions: list[VGScientaRegion] = Field(default_factory=lambda: [])
+    regions: list[VGScientaRegion[TLensMode]] = Field(default_factory=lambda: [])
 
     def get_excitation_energy_source_by_region(
-        self, region: VGScientaRegion
+        self, region: VGScientaRegion[TLensMode]
     ) -> VGScientaExcitationEnergySource:
         value = next(
             (

dodal/devices/fast_grid_scan.py

@@ -1,4 +1,3 @@
-import asyncio
 from abc import ABC, abstractmethod
 from typing import Generic, TypeVar
 
@@ -258,7 +257,7 @@ class FastGridScanCommon(StandardReadable, Flyable, ABC, Generic[ParamType]):
     async def complete(self):
         try:
             await wait_for_value(self.status, 0, self.COMPLETE_STATUS)
-        except asyncio.TimeoutError:
+        except TimeoutError:
             LOGGER.error(
                 "Hyperion timed out waiting for FGS motion to complete. This may have been caused by a goniometer stage getting stuck.\n\
                 Forcibly stopping the FGS motion program..."

dodal/devices/i04/constants.py

@@ -4,6 +4,6 @@ from dataclasses import dataclass
 
 @dataclass(frozen=True)
 class RedisConstants:
-    REDIS_HOST = os.environ.get("VALKEY_PROD_SVC_SERVICE_HOST", "test_redis")
+    REDIS_HOST = os.environ.get("VALKEY_FOR_MURKO_PROD_SVC_SERVICE_HOST", "test_redis")
     REDIS_PASSWORD = os.environ.get("VALKEY_PASSWORD", "test_redis_password")
     MURKO_REDIS_DB = 7

dodal/devices/i09/__init__.py

@@ -0,0 +1,4 @@
+from dodal.devices.i09.dcm import DCM
+from dodal.devices.i09.enums import Grating, LensMode
+
+__all__ = ["DCM", "Grating", "LensMode"]

dodal/devices/i09/dcm.py

@@ -0,0 +1,26 @@
+from ophyd_async.core import derived_signal_r
+
+from dodal.devices.common_dcm import BaseDCM, PitchAndRollCrystal, StationaryCrystal
+
+
+class DCM(BaseDCM[PitchAndRollCrystal, StationaryCrystal]):
+    """
+    I09 double crystal monochromator (DCM), used to select the energy of the beam.
+    Differences:
+
+    1. Can provide energy in eV via dcm.energy_in_ev read signal
+
+    This DCM is available on i09 and i09_1 endstations.
+    """
+
+    def __init__(self, prefix: str, name: str = "") -> None:
+        super().__init__(prefix, PitchAndRollCrystal, StationaryCrystal, name)
+        self.energy_in_ev = derived_signal_r(
+            self._convert_keV_to_eV, energy_signal=self.energy_in_kev.user_readback
+        )
+        # Set name so that new child signals get correct name
+        # need to do it until https://github.com/bluesky/ophyd-async/pull/899 merged
+        self.set_name(self.name)
+
+    def _convert_keV_to_eV(self, energy_signal: float) -> float:
+        return energy_signal * 1000

dodal/devices/i09/enums.py

@@ -0,0 +1,15 @@
+from ophyd_async.core import StrictEnum
+
+
+class Grating(StrictEnum):
+    G_300 = "300 lines/mm"
+    G_400 = "400 lines/mm"
+    G_800 = "800 lines/mm"
+
+
+class LensMode(StrictEnum):
+    TRANSMISSION = "Transmission"
+    ANGULAR45 = "Angular45"
+    ANGULAR60 = "Angular60"
+    ANGULAR56 = "Angular56"
+    ANGULAR45VUV = "Angular45VUV"

dodal/devices/i09_1/__init__.py

@@ -0,0 +1,3 @@
+from .enums import LensMode
+
+__all__ = ["LensMode"]

dodal/devices/i09_1/enums.py

@@ -0,0 +1,19 @@
+from ophyd_async.core import SupersetEnum
+
+
+class LensMode(SupersetEnum):
+    LARGE_AREA = "LargeArea"
+    MEDIUM_ANGULAR_DISPERSION = "MediumAngularDispersion"
+    MEDIUM_AREA = "MediumArea"
+    SMALL_AREA = "SmallArea"
+    HIGH_MAGNIFICATION = "HighMagnification"
+    LOW_ANGULAR_DISPERSION = "LowAngularDispersion"
+    LOW_ANGULAR_DISPERSION2 = "LowAngularDispersion2"
+    HIGH_ANGULAR_DISPERSION = "HighAngularDispersion"
+    WIDE_ANGLE_MODE = "WideAngleMode"
+    MEDIUM_ANGLE_MODE = "MediumAngleMode"
+    MEDIUM_MAGNIFICATION = "MediumMagnification"
+    LOW_MAGNIFICATION = "LowMagnification"
+    HIGH_MAGNIFICATION2 = "HighMagnification2"
+    RAMP_MODE = "RampMode"
+    NOT_CONNECTED = "Not connected"

dodal/devices/i10/mirrors.py

@@ -1,18 +1,16 @@
-from ophyd_async.core import StandardReadable
 from ophyd_async.epics.core import epics_signal_rw
 from ophyd_async.epics.motor import Motor
 
+from dodal.devices.motors import XYZStage
 
-class PiezoMirror(StandardReadable):
+
+class PiezoMirror(XYZStage):
     def __init__(
         self,
         prefix: str,
         name: str = "",
     ):
         with self.add_children_as_readables():
-            self.x = Motor(prefix + "X")
-            self.y = Motor(prefix + "Y")
-            self.z = Motor(prefix + "Z")
             self.yaw = Motor(prefix + "YAW")
             self.pitch = Motor(prefix + "PITCH")
             self.roll = Motor(prefix + "ROLL")
@@ -21,4 +19,4 @@ class PiezoMirror(StandardReadable):
                 read_pv=prefix + "FPITCH:RBV:AI",
                 write_pv=prefix + "FPITCH:DMD:AO",
             )
-        super().__init__(name=name)
+        super().__init__(prefix, name)

dodal/devices/i10/rasor/rasor_motors.py

@@ -2,20 +2,6 @@ from ophyd_async.core import StandardReadable
 from ophyd_async.epics.motor import Motor
 
 
-class PinHole(StandardReadable):
-    "Two motors stage for rasor pinhole"
-
-    def __init__(
-        self,
-        prefix: str,
-        name: str = "",
-    ):
-        with self.add_children_as_readables():
-            self.x = Motor(prefix + "X")
-            self.y = Motor(prefix + "Y")
-        super().__init__(name=name)
-
-
 class Diffractometer(StandardReadable):
     def __init__(
         self,

dodal/devices/i19/beamstop.py

@@ -1,6 +1,7 @@
 from ophyd_async.core import StandardReadable, StrictEnum
 from ophyd_async.epics.core import epics_signal_rw, epics_signal_x
-from ophyd_async.epics.motor import Motor
+
+from dodal.devices.motors import XYZStage
 
 
 class HomeGroup(StrictEnum):
@@ -18,13 +19,8 @@ class HomingControl(StandardReadable):
         super().__init__(name)
 
 
-class BeamStop(StandardReadable):
+class BeamStop(XYZStage):
     def __init__(self, prefix: str, name: str = "") -> None:
-        with self.add_children_as_readables():
-            self.x = Motor(f"{prefix}X")
-            self.y = Motor(f"{prefix}Y")
-            self.z = Motor(f"{prefix}Z")
-
         self.homing = HomingControl(f"{prefix}HM", name)
 
         super().__init__(name)

dodal/devices/i24/aperture.py

@@ -1,6 +1,7 @@
-from ophyd_async.core import StandardReadable, StrictEnum
+from ophyd_async.core import StrictEnum
 from ophyd_async.epics.core import epics_signal_rw
-from ophyd_async.epics.motor import Motor
+
+from dodal.devices.motors import XYStage
 
 
 class AperturePositions(StrictEnum):
@@ -10,7 +11,7 @@ class AperturePositions(StrictEnum):
     MANUAL = "Manual Mounting"
 
 
-class Aperture(StandardReadable):
+class Aperture(XYStage):
     """Device to trigger the aperture motor move on I24.
 
     The aperture positioner has 4 possible positions: In, Out, Robot and Manual.
@@ -20,8 +21,5 @@ class Aperture(StandardReadable):
     """
 
     def __init__(self, prefix: str, name: str = "") -> None:
-        self.x = Motor(prefix + "X")
-        self.y = Motor(prefix + "Y")
-
         self.position = epics_signal_rw(AperturePositions, prefix + "MP:SELECT")
         super().__init__(name)

dodal/devices/i24/beamstop.py

@@ -1,7 +1,9 @@
-from ophyd_async.core import StandardReadable, StrictEnum
+from ophyd_async.core import StrictEnum
 from ophyd_async.epics.core import epics_signal_rw
 from ophyd_async.epics.motor import Motor
 
+from dodal.devices.motors import XYZStage
+
 
 class BeamstopPositions(StrictEnum):
     CHECK_BEAM = "CheckBeam"
@@ -12,7 +14,7 @@ class BeamstopPositions(StrictEnum):
     ROBOT = "Robot"
 
 
-class Beamstop(StandardReadable):
+class Beamstop(XYZStage):
     """Device to move the beamstop.
 
     The positioner moves the x,y,z motors when a position is selected.
@@ -25,12 +27,7 @@ class Beamstop(StandardReadable):
     """
 
     def __init__(self, prefix: str, name: str = "") -> None:
-        self.x = Motor(prefix + "X")
-        self.y = Motor(prefix + "Y")
-        self.z = Motor(prefix + "Z")
-
         self.y_rotation = Motor(prefix + "ROTY")
-
         self.pos_select = epics_signal_rw(BeamstopPositions, prefix + "MP:SELECT")
 
-        super().__init__(name)
+        super().__init__(prefix, name)

dodal/devices/i24/pmac.py

@@ -9,13 +9,13 @@ from ophyd_async.core import (
     Reference,
     SignalR,
     SignalRW,
-    StandardReadable,
     observe_signals_value,
     soft_signal_rw,
     wait_for_value,
 )
 from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
-from ophyd_async.epics.motor import Motor
+
+from dodal.devices.motors import XYZStage
 
 HOME_STR = r"\#1hmz\#2hmz\#3hmz"  # Command to home the PMAC motors
 ZERO_STR = "!x0y0z0"  # Command to blend any ongoing move into new position
@@ -192,7 +192,7 @@ class ProgramAbort(Triggerable):
         )
 
 
-class PMAC(StandardReadable):
+class PMAC(XYZStage):
     """Device to control the chip stage on I24."""
 
     def __init__(self, prefix: str, name: str = "") -> None:
@@ -209,10 +209,6 @@ class PMAC(StandardReadable):
             self.pmac_string,
         )
 
-        self.x = Motor(prefix + "X")
-        self.y = Motor(prefix + "Y")
-        self.z = Motor(prefix + "Z")
-
         # These next signals are readback values on PVARS which are set by the motion
         # program.
         self.scanstatus = epics_signal_r(float, "BL24I-MO-STEP-14:signal:P2401")
@@ -232,4 +228,4 @@ class PMAC(StandardReadable):
         )
         self.abort_program = ProgramAbort(self.pmac_string, self.scanstatus)
 
-        super().__init__(name)
+        super().__init__(prefix, name)

dodal/devices/linkam3.py

@@ -1,14 +1,7 @@
-import asyncio
-import time
-
-from bluesky.protocols import Location
 from ophyd_async.core import (
     StandardReadable,
     StandardReadableFormat,
     StrictEnum,
-    WatchableAsyncStatus,
-    WatcherUpdate,
-    observe_value,
 )
 from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
 
@@ -18,6 +11,8 @@ class PumpControl(StrictEnum):
     AUTO = "Auto"
 
 
+# TODO: Make use of Status PV:
+# https://github.com/DiamondLightSource/dodal/issues/338
 class Linkam3(StandardReadable):
     """Device to represent a Linkam3 temperature controller
 
@@ -34,81 +29,30 @@ class Linkam3(StandardReadable):
     settle_time: int = 0
 
     def __init__(self, prefix: str, name: str = ""):
-        self.temp = epics_signal_r(float, prefix + "TEMP:")
-        self.dsc = epics_signal_r(float, prefix + "DSC:")
-        self.start_heat = epics_signal_rw(bool, prefix + "STARTHEAT:")
-
-        self.ramp_rate = epics_signal_rw(
-            float, prefix + "RAMPRATE:", prefix + "RAMPRATE:SET:"
-        )
-        self.ramp_time = epics_signal_r(float, prefix + "RAMPTIME:")
-        self.set_point = epics_signal_rw(
-            float, prefix + "SETPOINT:", prefix + "SETPOINT:SET:"
-        )
-        self.pump_control = epics_signal_r(
-            PumpControl,
-            prefix + "LNP_MODE:SET:",
-        )
-        self.speed = epics_signal_rw(
-            float, prefix + "LNP_SPEED:", prefix + "LNP_SPEED:SET:"
-        )
-
-        self.chamber_vac = epics_signal_r(float, prefix + "VAC_CHAMBER:")
-        self.sensor_vac = epics_signal_r(float, prefix + "VAC_DATA1:")
-
-        self.error = epics_signal_r(str, prefix + "CTRLLR:ERR:")
-
-        # status is a bitfield stored in a double?
-        self.status = epics_signal_r(float, prefix + "STATUS:")
-
-        self.add_readables((self.temp,), format=StandardReadableFormat.HINTED_SIGNAL)
-        self.add_readables(
-            (self.ramp_rate, self.speed, self.set_point),
-            format=StandardReadableFormat.CONFIG_SIGNAL,
-        )
-
-        super().__init__(name=name)
-
-    @WatchableAsyncStatus.wrap
-    async def set(self, new_position: float, timeout: float | None = None):
-        # time.monotonic won't go backwards in case of NTP corrections
-        start = time.monotonic()
-        old_position = await self.set_point.get_value()
-        await self.set_point.set(new_position, wait=True)
-        async for current_position in observe_value(self.temp):
-            yield WatcherUpdate(
-                name=self.name,
-                current=current_position,
-                initial=old_position,
-                target=new_position,
-                time_elapsed=time.monotonic() - start,
+        with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
+            self.temp = epics_signal_r(float, prefix + "TEMP")
+        with self.add_children_as_readables():
+            self.dsc = epics_signal_r(float, prefix + "DSC")
+            self.start_heat = epics_signal_rw(bool, prefix + "STARTHEAT")
+
+            self.ramp_rate = epics_signal_rw(
+                float, prefix + "RAMPRATE", prefix + "RAMPRATE:SET"
+            )
+            self.ramp_time = epics_signal_r(float, prefix + "RAMPTIME")
+            self.set_point = epics_signal_rw(
+                float, prefix + "SETPOINT", prefix + "SETPOINT:SET"
+            )
+            self.pump_control = epics_signal_r(
+                PumpControl,
+                prefix + "LNP_MODE:SET",
+            )
+            self.speed = epics_signal_rw(
+                float, prefix + "LNP_SPEED", prefix + "LNP_SPEED:SET"
             )
-            if abs(current_position - new_position) < self.tolerance:
-                await asyncio.sleep(self.settle_time)
-                break
-
-    # TODO: Make use of values in Status.
-    # https://github.com/DiamondLightSource/dodal/issues/338
-    async def _is_nth_bit_set(self, n: int) -> bool:
-        return bool(int(await self.status.get_value()) & 1 << n)
-
-    async def in_error(self) -> bool:
-        return await self._is_nth_bit_set(0)
-
-    async def at_setpoint(self) -> bool:
-        return await self._is_nth_bit_set(1)
-
-    async def heater_on(self) -> bool:
-        return await self._is_nth_bit_set(2)
 
-    async def pump_on(self) -> bool:
-        return await self._is_nth_bit_set(3)
+            self.chamber_vac = epics_signal_r(float, prefix + "VAC_CHAMBER")
+            self.sensor_vac = epics_signal_r(float, prefix + "VAC_DATA1")
 
-    async def pump_auto(self) -> bool:
-        return await self._is_nth_bit_set(4)
+            self.error = epics_signal_r(str, prefix + "CTRLLR:ERR")
 
-    async def locate(self) -> Location:
-        return {
-            "readback": await self.temp.get_value(),
-            "setpoint": await self.set_point.get_value(),
-        }
+        super().__init__(name=name)