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

dodal/beamlines/i04.py

@@ -1,7 +1,8 @@
-import os
-
 from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
-from dodal.common.beamlines.beamline_utils import device_factory, device_instantiation
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    device_instantiation,
+)
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.aperturescatterguard import (
     AperturePosition,
@@ -17,12 +18,16 @@ from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import ZebraFastGridScan
 from dodal.devices.flux import Flux
 from dodal.devices.i03.dcm import DCM
+from dodal.devices.i04.constants import RedisConstants
+from dodal.devices.i04.murko_results import MurkoResultsDevice
 from dodal.devices.i04.transfocator import Transfocator
 from dodal.devices.ipin import IPin
 from dodal.devices.motors import XYZPositioner
-from dodal.devices.oav.oav_detector import OAV
+from dodal.devices.mx_phase1.beamstop import Beamstop
+from dodal.devices.oav.oav_detector import OAVBeamCentrePV
 from dodal.devices.oav.oav_parameters import OAVConfig
 from dodal.devices.oav.oav_to_redis_forwarder import OAVToRedisForwarder
+from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.devices.robot import BartRobot
 from dodal.devices.s4_slit_gaps import S4SlitGaps
 from dodal.devices.smargon import Smargon
@@ -37,6 +42,7 @@ from dodal.devices.zebra.zebra_constants_mapping import (
     ZebraTTLOutputs,
 )
 from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter
+from dodal.devices.zocalo import ZocaloResults
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -46,11 +52,8 @@ ZOOM_PARAMS_FILE = (
 DISPLAY_CONFIG = "/dls_sw/i04/software/gda_versions/var/display.configuration"
 DAQ_CONFIGURATION_PATH = "/dls_sw/i04/software/daq_configuration"
 
-REDIS_HOST = "i04-valkey-murko.diamond.ac.uk"
-REDIS_PASSWORD = os.environ.get("VALKEY_PASSWORD", "test_redis_password")
-MURKO_REDIS_DB = 7
 
-BL = get_beamline_name("s04")
+BL = get_beamline_name("i04")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
@@ -107,13 +110,13 @@ def ipin() -> IPin:
 
 
 @device_factory()
-def beamstop() -> XYZPositioner:
+def beamstop() -> Beamstop:
     """Get the i04 beamstop device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i04, it will return the existing object.
     """
-    return XYZPositioner(
+    return Beamstop(
         f"{PREFIX.beamline_prefix}-MO-BS-01:",
-        "beamstop",
+        beamline_parameters=get_beamline_parameters(),
     )
 
 
@@ -294,18 +297,25 @@ def zebra() -> Zebra:
 
 
 @device_factory(skip=BL == "s04")
-def oav(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-    params: OAVConfig | None = None,
-) -> OAV:
+def oav(params: OAVConfig | None = None) -> OAVBeamCentrePV:
+    """Get the i04 OAV device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return OAVBeamCentrePV(
+        prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
+        config=params or OAVConfig(ZOOM_PARAMS_FILE),
+    )
+
+
+@device_factory(skip=BL == "s04")
+def oav_full_screen(params: OAVConfig | None = None) -> OAVBeamCentrePV:
     """Get the i04 OAV device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i04, it will return the existing object.
     """
-    return OAV(
+    return OAVBeamCentrePV(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        name="oav",
-        config=params or OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=params or OAVConfig(ZOOM_PARAMS_FILE),
+        overlay_channel=3,
     )
 
 
@@ -350,19 +360,48 @@ def oav_to_redis_forwarder() -> OAVToRedisForwarder:
     return OAVToRedisForwarder(
         f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         name="oav_to_redis_forwarder",
-        redis_host=REDIS_HOST,
-        redis_password=REDIS_PASSWORD,
-        redis_db=7,
+        redis_host=RedisConstants.REDIS_HOST,
+        redis_password=RedisConstants.REDIS_PASSWORD,
+        redis_db=RedisConstants.MURKO_REDIS_DB,
+    )
+
+
+@device_factory()
+def murko_results() -> MurkoResultsDevice:
+    """Get the i04 OAV to redis forwarder, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return MurkoResultsDevice(
+        name="murko_results",
+        redis_host=RedisConstants.REDIS_HOST,
+        redis_password=RedisConstants.REDIS_PASSWORD,
+        redis_db=RedisConstants.MURKO_REDIS_DB,
     )
 
 
 @device_factory()
 def diamond_filter() -> DiamondFilter[I04Filters]:
     """Get the i04 diamond filter device, instantiate it if it hasn't already been.
-    If this is called when already instantiated in i03, it will return the existing object.
+    If this is called when already instantiated in i04, it will return the existing object.
     """
     return DiamondFilter[I04Filters](
-        prefix=f"{PREFIX.beamline_prefix}-MO-FLTR-01:",
-        name="diamond_filter",
-        data_type=I04Filters,
+        f"{PREFIX.beamline_prefix}-MO-FLTR-01:Y", I04Filters
+    )
+
+
+@device_factory()
+def zocalo() -> ZocaloResults:
+    """Get the i04 ZocaloResults device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return ZocaloResults(channel="xrc.i04")
+
+
+@device_factory()
+def pin_tip_detection() -> PinTipDetection:
+    """Get the i04 pin tip detection device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i04, it will return the existing object.
+    """
+    return PinTipDetection(
+        f"{PREFIX.beamline_prefix}-DI-OAV-01:",
     )

dodal/beamlines/i09.py

@@ -2,9 +2,7 @@ from dodal.common.beamlines.beamline_utils import (
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.electron_analyser.vgscienta_analyser_io import (
-    VGScientaAnalyserDriverIO,
-)
+from dodal.devices.electron_analyser.vgscienta import VGScientaAnalyserDriverIO
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name

dodal/beamlines/i09_1.py

@@ -2,9 +2,7 @@ from dodal.common.beamlines.beamline_utils import (
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.electron_analyser.specs_analyser_io import (
-    SpecsAnalyserDriverIO,
-)
+from dodal.devices.electron_analyser.specs import SpecsAnalyserDriverIO
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name

dodal/beamlines/i18.py

@@ -113,7 +113,7 @@ def hfm() -> KBMirror:
 
 
 @device_factory()
-def d7diode() -> Diode:
+def d7_diode() -> Diode:
     return Diode(f"{PREFIX.beamline_prefix}-DI-PHDGN-07:")
 
 

dodal/beamlines/i19_1.py

@@ -6,9 +6,12 @@ from dodal.common.beamlines.beamline_utils import (
 )
 from dodal.devices.i19.beamstop import BeamStop
 from dodal.devices.i19.blueapi_device import HutchState
-from dodal.devices.i19.shutter import AccessControlledShutter
-from dodal.devices.oav.oav_detector import OAV
-from dodal.devices.oav.oav_parameters import OAVConfig
+from dodal.devices.i19.shutter import (
+    AccessControlledShutter,
+    HutchState,
+)
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
@@ -48,10 +51,10 @@ def beamstop() -> BeamStop:
 
 
 @device_factory()
-def oav() -> OAV:
-    return OAV(
+def oav() -> OAVBeamCentreFile:
+    return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-EA-OAV-01:",
-        config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
     )
 
 

dodal/beamlines/i23.py

@@ -1,5 +1,6 @@
 from pathlib import Path
 
+from ophyd_async.core import StrictEnum
 from ophyd_async.epics.adpilatus import PilatusDetector
 
 from dodal.common.beamlines.beamline_utils import (
@@ -12,6 +13,7 @@ from dodal.common.beamlines.device_helpers import HDF5_SUFFIX
 from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
 from dodal.devices.motors import SixAxisGonio
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
+from dodal.devices.positioner import Positioner1D
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
     ZebraMapping,
@@ -39,10 +41,15 @@ PREFIX = BeamlinePrefix(BL)
 I23_ZEBRA_MAPPING = ZebraMapping(
     outputs=ZebraTTLOutputs(TTL_DETECTOR=1, TTL_SHUTTER=4),
     sources=ZebraSources(),
-    AND_GATE_FOR_AUTO_SHUTTER=2,
 )
 
 
+class I23DetectorPositions(StrictEnum):
+    IN = "In"
+    OUT = "Out"
+    SAMPLE_CHANGE = "sample change"
+
+
 def _is_i23_machine():
     """
     Devices using PVA can only connect from i23 machines, due to the absence of
@@ -93,3 +100,12 @@ def pilatus() -> PilatusDetector:
         drv_suffix="cam1:",
         fileio_suffix=HDF5_SUFFIX,
     )
+
+
+@device_factory()
+def detector_motion() -> Positioner1D[I23DetectorPositions]:
+    """Get the i23 detector"""
+    return Positioner1D[I23DetectorPositions](
+        f"{PREFIX.beamline_prefix}-EA-DET-01:Z",
+        datatype=I23DetectorPositions,
+    )

dodal/beamlines/i24.py

@@ -15,8 +15,8 @@ from dodal.devices.i24.i24_detector_motion import DetectorMotion
 from dodal.devices.i24.pilatus_metadata import PilatusMetadata
 from dodal.devices.i24.pmac import PMAC
 from dodal.devices.i24.vgonio import VerticalGoniometer
-from dodal.devices.oav.oav_detector import OAV
-from dodal.devices.oav.oav_parameters import OAVConfig
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
     ZebraMapping,
@@ -150,11 +150,11 @@ def pmac() -> PMAC:
 
 
 @device_factory(skip=BL == "s24")
-def oav() -> OAV:
-    return OAV(
+def oav() -> OAVBeamCentreFile:
+    return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         name="oav",
-        config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
     )
 
 

dodal/beamlines/p38.py

@@ -40,7 +40,7 @@ set_utils_beamline(BL)
 set_path_provider(
     StaticVisitPathProvider(
         BL,
-        Path("/dls/p38/data/2024/cm37282-2/bluesky"),
+        Path("/dls/p38/data/2025/cm40650-2/bluesky"),
         client=LocalDirectoryServiceClient(),
     )
 )

dodal/beamlines/p60.py

@@ -2,9 +2,7 @@ from dodal.common.beamlines.beamline_utils import (
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.electron_analyser.vgscienta_analyser_io import (
-    VGScientaAnalyserDriverIO,
-)
+from dodal.devices.electron_analyser.vgscienta import VGScientaAnalyserDriverIO
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -16,6 +14,4 @@ set_utils_beamline(BL)
 
 @device_factory()
 def analyser_driver() -> VGScientaAnalyserDriverIO:
-    return VGScientaAnalyserDriverIO(
-        name="analyser_driver", prefix=f"{PREFIX.beamline_prefix}-EA-DET-01:CAM:"
-    )
+    return VGScientaAnalyserDriverIO(prefix=f"{PREFIX.beamline_prefix}-EA-DET-01:CAM:")

dodal/beamlines/p99.py

@@ -1,7 +1,22 @@
-from dodal.common.beamlines.beamline_utils import device_factory, set_beamline
+from pathlib import Path
+
+from ophyd_async.epics.adandor import Andor2Detector
+
+from dodal.common.beamlines.beamline_utils import (
+    device_factory,
+    get_path_provider,
+    set_beamline,
+    set_path_provider,
+)
+from dodal.common.beamlines.device_helpers import CAM_SUFFIX, HDF5_SUFFIX
+from dodal.common.visit import (
+    LocalDirectoryServiceClient,
+    StaticVisitPathProvider,
+)
 from dodal.devices.attenuator.filter import FilterMotor
 from dodal.devices.attenuator.filter_selections import P99FilterSelections
 from dodal.devices.motors import XYZPositioner
+from dodal.devices.p99.andor2_point import Andor2Point
 from dodal.devices.p99.sample_stage import SampleAngleStage
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -19,9 +34,7 @@ def angle_stage() -> SampleAngleStage:
 
 @device_factory()
 def filter() -> FilterMotor:
-    return FilterMotor(
-        f"{PREFIX.beamline_prefix}-MO-STAGE-02:MP:SELECT", P99FilterSelections
-    )
+    return FilterMotor(f"{PREFIX.beamline_prefix}-MO-STAGE-02:MP:", P99FilterSelections)
 
 
 @device_factory()
@@ -32,3 +45,34 @@ def sample_stage() -> XYZPositioner:
 @device_factory()
 def lab_stage() -> XYZPositioner:
     return XYZPositioner(f"{PREFIX.beamline_prefix}-MO-STAGE-02:LAB:")
+
+
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/dls/p99/data/2024/cm37284-2/processing/writenData"),
+        client=LocalDirectoryServiceClient(),  # RemoteDirectoryServiceClient("http://p99-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def andor2_det() -> Andor2Detector:
+    """Andor model:DU897_BV."""
+    return Andor2Detector(
+        prefix=f"{PREFIX.beamline_prefix}-EA-DET-03:",
+        path_provider=get_path_provider(),
+        drv_suffix=CAM_SUFFIX,
+        fileio_suffix=HDF5_SUFFIX,
+    )
+
+
+@device_factory()
+def andor2_point() -> Andor2Point:
+    """Using the andor2 as if it is a massive point detector, read the meanValue and total after
+    a picture is taken."""
+    return Andor2Point(
+        prefix=f"{PREFIX.beamline_prefix}-EA-DET-03:",
+        drv_suffix=CAM_SUFFIX,
+        read_uncached={"mean": "STAT:MeanValue_RBV", "total": "STAT:Total_RBV"},
+    )

dodal/common/beamlines/beamline_parameters.py

@@ -1,3 +1,4 @@
+import ast
 from typing import Any, cast
 
 from dodal.log import LOGGER
@@ -8,7 +9,6 @@ BEAMLINE_PARAMETER_KEYWORDS = ["FB", "FULL", "deadtime"]
 BEAMLINE_PARAMETER_PATHS = {
     "i03": "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters",
     "i04": "/dls_sw/i04/software/gda_versions/gda_9_34/workspace_git/gda-mx.git/configurations/i04-config/scripts/beamlineParameters",
-    "s03": "tests/test_data/test_beamline_parameters.txt",
 }
 
 
@@ -58,41 +58,14 @@ class GDABeamlineParameters:
 
     @classmethod
     def parse_value(cls, value: str):
-        if value[0] == "[":
-            return cls.parse_list(value[1:].strip())
-        else:
-            return cls.parse_list_element(value)
-
-    @classmethod
-    def parse_list_element(cls, value: str):
-        if value == "Yes":
-            return True
-        elif value == "No":
-            return False
-        else:
-            return float(value)
-
-    @classmethod
-    def parse_list(cls, value: str):
-        list_output = []
-        remaining = value.strip()
-        i = 0
-        while (i := remaining.find(",")) != -1:
-            list_output.append(cls.parse_list_element(remaining[:i]))
-            remaining = remaining[i + 1 :].lstrip()
-        if (i := remaining.find("]")) != -1:
-            list_output.append(cls.parse_list_element(remaining[:i]))
-            remaining = remaining[i + 1 :].lstrip()
-        else:
-            raise ValueError("Missing closing ']' in list expression")
-        return list_output
+        return ast.literal_eval(value.replace("Yes", "True").replace("No", "False"))
 
 
 def get_beamline_parameters(beamline_param_path: str | None = None):
     """Loads the beamline parameters from the specified path, or according to the
     environment variable if none is given"""
     if not beamline_param_path:
-        beamline_name = get_beamline_name("s03")
+        beamline_name = get_beamline_name("i03")
         beamline_param_path = BEAMLINE_PARAMETER_PATHS.get(beamline_name)
         if beamline_param_path is None:
             raise KeyError(

dodal/common/data_util.py

@@ -1,3 +1,4 @@
+import os
 from typing import TypeVar
 
 from pydantic import BaseModel
@@ -9,6 +10,9 @@ def load_json_file_to_class(
     t: type[TBaseModel],
     file: str,
 ) -> TBaseModel:
+    if not os.path.isfile(file):
+        raise FileNotFoundError(f"Cannot find file {file}")
+
     with open(file) as f:
         json_obj = f.read()
     cls = t.model_validate_json(json_obj)

dodal/devices/aithre_lasershaping/goniometer.py

@@ -1,9 +1,21 @@
-from ophyd_async.core import StandardReadable
+import asyncio
+import math
+
+from ophyd_async.core import StandardReadable, derived_signal_rw
 from ophyd_async.epics.motor import Motor
 
 
 class Goniometer(StandardReadable):
-    """Goniometer and the stages it sits on"""
+    """The Aithre lab goniometer and the XYZ stage it sits on.
+
+    `x`, `y` and `z` control the axes of the positioner at the base, while `sampy` and
+    `sampz` control the positioner of the sample. `omega` is the rotation about the
+    x-axis (along the length of the sample holder).
+
+    The `vertical_position` signal refers to the height of the sample from the point of
+    view of the OAV and setting this value moves the sample vertically in the OAV plane
+    regardless of the current rotation.
+    """
 
     def __init__(self, prefix: str, name: str = "") -> None:
         self.x = Motor(prefix + "X")
@@ -12,4 +24,26 @@ class Goniometer(StandardReadable):
         self.sampy = Motor(prefix + "SAMPY")
         self.sampz = Motor(prefix + "SAMPZ")
         self.omega = Motor(prefix + "OMEGA")
+        self.vertical_position = derived_signal_rw(
+            self._get,
+            self._set,
+            sampy=self.sampy,
+            sampz=self.sampz,
+            omega=self.omega,
+        )
         super().__init__(name)
+
+    def _get(self, sampz: float, sampy: float, omega: float) -> float:
+        z_component = sampz * math.cos(math.radians(omega))
+        y_component = sampy * math.sin(math.radians(omega))
+        return z_component + y_component
+
+    async def _set(self, value: float) -> None:
+        omega = await self.omega.user_readback.get_value()
+        z_component = value * math.cos(math.radians(omega))
+        y_component = value * math.sin(math.radians(omega))
+        await asyncio.gather(
+            self.sampy.set(y_component),
+            self.sampz.set(z_component),
+            self.omega.set(omega),
+        )

dodal/devices/aithre_lasershaping/laser_robot.py

@@ -0,0 +1,27 @@
+from ophyd_async.core import StrictEnum
+from ophyd_async.epics.core import epics_signal_rw
+
+from dodal.devices.robot import BartRobot
+
+
+class ForceBit(StrictEnum):
+    ON = "On"
+    NO = "No"
+    OFF = "Off"
+
+
+class LidHeatEnable(StrictEnum):
+    ENABLED = "Enabled"
+    DISABLED = "Disabled"
+
+
+class LaserRobot(BartRobot):
+    def __init__(self, name: str, prefix: str) -> None:
+        self.dewar_lid_heater = epics_signal_rw(
+            LidHeatEnable, prefix + "DW_1_ENABLED", prefix + "DW_1_CTRL"
+        )
+        self.cryojet_retract = epics_signal_rw(ForceBit, prefix + "OP_24_FORCE_OPTION")
+        self.set_beamline_safe = epics_signal_rw(
+            ForceBit, prefix + "IP_16_FORCE_OPTION"
+        )
+        super().__init__(name=name, prefix=prefix)