dls-dodal 1.36.0__py3-none-any.whl → 1.36.2__py3-none-any.whl

dodal/beamlines/i22.py

@@ -5,12 +5,12 @@ from ophyd_async.epics.adpilatus import PilatusDetector
 from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
-    device_instantiation,
+    device_factory,
     get_path_provider,
     set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.common.beamlines.device_helpers import numbered_slits
+from dodal.common.beamlines.device_helpers import HDF5_PREFIX
 from dodal.common.crystal_metadata import (
     MaterialsEnum,
     make_crystal_metadata_from_material,
@@ -27,9 +27,10 @@ from dodal.devices.tetramm import TetrammDetector
 from dodal.devices.undulator import Undulator
 from dodal.devices.watsonmarlow323_pump import WatsonMarlow323Pump
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
+from dodal.utils import BeamlinePrefix, get_beamline_name
 
 BL = get_beamline_name("i22")
+PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
@@ -47,237 +48,141 @@ set_path_provider(
 )
 
 
-def saxs(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> PilatusDetector:
-    return device_instantiation(
-        NXSasPilatus,
-        "saxs",
-        "-EA-PILAT-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        drv_suffix="CAM:",
-        hdf_suffix="HDF5:",
-        metadata_holder=NXSasMetadataHolder(
-            x_pixel_size=(1.72e-1, "mm"),
-            y_pixel_size=(1.72e-1, "mm"),
-            description="Dectris Pilatus3 2M",
-            type="Photon Counting Hybrid Pixel",
-            sensor_material="silicon",
-            sensor_thickness=(0.45, "mm"),
-            distance=(4711.833684146172, "mm"),
-        ),
+@device_factory()
+def saxs() -> PilatusDetector:
+    metadata_holder = NXSasMetadataHolder(
+        x_pixel_size=(1.72e-1, "mm"),
+        y_pixel_size=(1.72e-1, "mm"),
+        description="Dectris Pilatus3 2M",
+        type="Photon Counting Hybrid Pixel",
+        sensor_material="silicon",
+        sensor_thickness=(0.45, "mm"),
+        distance=(4711.833684146172, "mm"),
+    )
+    return NXSasPilatus(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-01:",
         path_provider=get_path_provider(),
+        drv_suffix="CAM:",
+        hdf_suffix=HDF5_PREFIX,
+        metadata_holder=metadata_holder,
     )
 
 
-def synchrotron(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> Synchrotron:
-    return device_instantiation(
-        Synchrotron,
-        "synchrotron",
-        "",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
 
 
-def waxs(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> PilatusDetector:
-    return device_instantiation(
-        NXSasPilatus,
-        "waxs",
-        "-EA-PILAT-03:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        drv_suffix="CAM:",
-        hdf_suffix="HDF5:",
-        metadata_holder=NXSasMetadataHolder(
-            x_pixel_size=(1.72e-1, "mm"),
-            y_pixel_size=(1.72e-1, "mm"),
-            description="Dectris Pilatus3 2M",
-            type="Photon Counting Hybrid Pixel",
-            sensor_material="silicon",
-            sensor_thickness=(0.45, "mm"),
-            distance=(175.4199417092314, "mm"),
-        ),
+@device_factory()
+def waxs() -> PilatusDetector:
+    metadata_holder = NXSasMetadataHolder(
+        x_pixel_size=(1.72e-1, "mm"),
+        y_pixel_size=(1.72e-1, "mm"),
+        description="Dectris Pilatus3 2M",
+        type="Photon Counting Hybrid Pixel",
+        sensor_material="silicon",
+        sensor_thickness=(0.45, "mm"),
+        distance=(175.4199417092314, "mm"),
+    )
+    return NXSasPilatus(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-03:",
         path_provider=get_path_provider(),
+        drv_suffix="CAM:",
+        hdf_suffix=HDF5_PREFIX,
+        metadata_holder=metadata_holder,
     )
 
 
-def i0(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> TetrammDetector:
-    return device_instantiation(
-        TetrammDetector,
-        "i0",
-        "-EA-XBPM-02:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        type="Cividec Diamond XBPM",
+@device_factory()
+def i0() -> TetrammDetector:
+    return TetrammDetector(
+        prefix=f"{PREFIX.beamline_prefix}-EA-XBPM-02:",
         path_provider=get_path_provider(),
+        type="Cividec Diamond XBPM",
     )
 
 
-def it(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> TetrammDetector:
-    return device_instantiation(
-        TetrammDetector,
-        "it",
-        "-EA-TTRM-02:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        type="PIN Diode",
+@device_factory()
+def it() -> TetrammDetector:
+    return TetrammDetector(
+        prefix=f"{PREFIX.beamline_prefix}-EA-TTRM-02:",
         path_provider=get_path_provider(),
+        type="PIN Diode",
     )
 
 
-def vfm(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> FocusingMirror:
-    return device_instantiation(
-        FocusingMirror,
-        "vfm",
-        "-OP-KBM-01:VFM:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory()
+def vfm() -> FocusingMirror:
+    return FocusingMirror(
+        prefix=f"{PREFIX.beamline_prefix}-OP-KBM-01:VFM:",
     )
 
 
-def hfm(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> FocusingMirror:
-    return device_instantiation(
-        FocusingMirror,
-        "hfm",
-        "-OP-KBM-01:HFM:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory()
+def hfm() -> FocusingMirror:
+    return FocusingMirror(
+        prefix=f"{PREFIX.beamline_prefix}-OP-KBM-01:HFM:",
     )
 
 
-def dcm(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> DoubleCrystalMonochromator:
-    return device_instantiation(
-        DoubleCrystalMonochromator,
-        "dcm",
-        f"{BeamlinePrefix(BL).beamline_prefix}-MO-DCM-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        bl_prefix=False,
-        temperature_prefix=f"{BeamlinePrefix(BL).beamline_prefix}-DI-DCM-01:",
+@device_factory()
+def dcm() -> DoubleCrystalMonochromator:
+    return DoubleCrystalMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-MO-DCM-01:",
+        temperature_prefix=f"{PREFIX.beamline_prefix}-DI-DCM-01:",
         crystal_1_metadata=make_crystal_metadata_from_material(
             MaterialsEnum.Si, (1, 1, 1)
         ),
         crystal_2_metadata=make_crystal_metadata_from_material(
-            MaterialsEnum.Si,
-            (1, 1, 1),
+            MaterialsEnum.Si, (1, 1, 1)
         ),
     )
 
 
-def undulator(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Undulator:
-    return device_instantiation(
-        Undulator,
-        "undulator",
-        f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        bl_prefix=False,
+@device_factory()
+def undulator() -> Undulator:
+    return Undulator(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        id_gap_lookup_table_path="/dls_sw/i22/software/daq_configuration/lookup/BeamLine_Undulator_toGap.txt",
         poles=80,
         length=2.0,
-        id_gap_lookup_table_path="/dls_sw/i22/software/daq_configuration/lookup/BeamLine_Undulator_toGap.txt",
     )
 
 
-def slits_1(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        1,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_1() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-01:")
 
 
-def slits_2(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        2,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_2() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-02:")
 
 
-def slits_3(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        3,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_3() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-03:")
 
 
-def slits_4(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        4,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_4() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-04:")
 
 
-def slits_5(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        5,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_5() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-05:")
 
 
-def slits_6(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> Slits:
-    return numbered_slits(
-        6,
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory()
+def slits_6() -> Slits:
+    return Slits(prefix=f"{PREFIX.beamline_prefix}-AL-SLITS-06:")
 
 
-def fswitch(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> FSwitch:
-    return device_instantiation(
-        FSwitch,
-        "fswitch",
-        "-MO-FSWT-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory()
+def fswitch() -> FSwitch:
+    return FSwitch(
+        prefix=f"{PREFIX.beamline_prefix}-MO-FSWT-01:",
         lens_geometry="paraboloid",
         cylindrical=True,
         lens_material="Beryllium",
@@ -286,107 +191,61 @@ def fswitch(
 
 # Must document what PandAs are physically connected to
 # See: https://github.com/bluesky/ophyd-async/issues/284
-def panda1(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> HDFPanda:
-    return device_instantiation(
-        HDFPanda,
-        "panda1",
-        "-EA-PANDA-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory()
+def panda1() -> HDFPanda:
+    return HDFPanda(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-01:",
         path_provider=get_path_provider(),
     )
 
 
-@skip_device()
-def panda2(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> HDFPanda:
-    return device_instantiation(
-        HDFPanda,
-        "panda2",
-        "-EA-PANDA-02:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory(skip=True)
+def panda2() -> HDFPanda:
+    return HDFPanda(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-02:",
         path_provider=get_path_provider(),
     )
 
 
-@skip_device()
-def panda3(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> HDFPanda:
-    return device_instantiation(
-        HDFPanda,
-        "panda3",
-        "-EA-PANDA-03:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory(skip=True)
+def panda3() -> HDFPanda:
+    return HDFPanda(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-03:",
         path_provider=get_path_provider(),
     )
 
 
-@skip_device()
-def panda4(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-) -> HDFPanda:
-    return device_instantiation(
-        HDFPanda,
-        "panda4",
-        "-EA-PANDA-04:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory(skip=True)
+def panda4() -> HDFPanda:
+    return HDFPanda(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-04:",
         path_provider=get_path_provider(),
     )
 
 
-def oav(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> AravisDetector:
-    return device_instantiation(
-        NXSasOAV,
-        "oav",
-        "-DI-OAV-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory()
+def oav() -> AravisDetector:
+    metadata_holder = NXSasMetadataHolder(
+        x_pixel_size=(3.45e-3, "mm"),  # Double check this figure
+        y_pixel_size=(3.45e-3, "mm"),
+        description="AVT Mako G-507B",
+        distance=(-1.0, "m"),
+    )
+    return NXSasOAV(
+        prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         drv_suffix="DET:",
-        hdf_suffix="HDF5:",
-        metadata_holder=NXSasMetadataHolder(
-            x_pixel_size=(3.45e-3, "mm"),  # Double check this figure
-            y_pixel_size=(3.45e-3, "mm"),
-            description="AVT Mako G-507B",
-            distance=(-1.0, "m"),
-        ),
+        hdf_suffix=HDF5_PREFIX,
         path_provider=get_path_provider(),
+        metadata_holder=metadata_holder,
     )
 
 
-@skip_device()
-def linkam(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> Linkam3:
-    return device_instantiation(
-        Linkam3,
-        "linkam",
-        "-EA-TEMPC-05",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+@device_factory(skip=True)
+def linkam() -> Linkam3:
+    return Linkam3(prefix=f"{PREFIX.beamline_prefix}-EA-TEMPC-05:")
 
 
-def ppump(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> WatsonMarlow323Pump:
+@device_factory()
+def ppump() -> WatsonMarlow323Pump:
     """Sample Environment Peristaltic Pump"""
-    return device_instantiation(
-        WatsonMarlow323Pump,
-        "ppump",
-        "-EA-PUMP-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-    )
+    return WatsonMarlow323Pump(f"{PREFIX.beamline_prefix}-EA-PUMP-01:")

dodal/beamlines/i24.py

@@ -1,16 +1,17 @@
-from dodal.common.beamlines.beamline_utils import (
-    BL,
-    device_instantiation,
-)
+from dodal.common.beamlines.beamline_utils import BL, device_instantiation
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.devices.attenuator import ReadOnlyAttenuator
 from dodal.devices.detector import DetectorParams
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.hutch_shutter import HutchShutter
 from dodal.devices.i24.aperture import Aperture
+from dodal.devices.i24.beam_center import DetectorBeamCenter
 from dodal.devices.i24.beamstop import Beamstop
 from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import DualBacklight
+from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
 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
@@ -29,6 +30,21 @@ set_log_beamline(BL)
 set_utils_beamline(BL)
 
 
+def attenuator(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> ReadOnlyAttenuator:
+    """Get a read-only attenuator device for i24, instantiate it if it hasn't already
+    been. If this is called when already instantiated in i24, it will return the
+    existing object."""
+    return device_instantiation(
+        ReadOnlyAttenuator,
+        "attenuator",
+        "-OP-ATTN-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )
+
+
 def aperture(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> Aperture:
@@ -70,7 +86,6 @@ def backlight(
     )
 
 
-@skip_device(lambda: BL == "s24")
 def detector_motion(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> DetectorMotion:
@@ -151,7 +166,6 @@ def oav(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) ->
     )
 
 
-@skip_device(lambda: BL == "s24")
 def vgonio(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> VerticalGoniometer:
@@ -180,7 +194,6 @@ def zebra(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -
     )
 
 
-@skip_device(lambda: BL == "s24")
 def shutter(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
 ) -> HutchShutter:
@@ -194,3 +207,55 @@ def shutter(
         wait_for_connection,
         fake_with_ophyd_sim,
     )
+
+
+def focus_mirrors(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> FocusMirrorsMode:
+    """Get the i24 focus mirror devise to find the beam size."""
+    return device_instantiation(
+        FocusMirrorsMode,
+        "focus_mirrors",
+        "-OP-MFM-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )
+
+
+def eiger_beam_center(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> DetectorBeamCenter:
+    """A device for setting/reading the beamcenter from the eiger on i24."""
+    return device_instantiation(
+        DetectorBeamCenter,
+        "eiger_bc",
+        "-EA-EIGER-01:CAM:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )
+
+
+def pilatus_beam_center(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> DetectorBeamCenter:
+    """A device for setting/reading the beamcenter from the pilatus on i24."""
+    return device_instantiation(
+        DetectorBeamCenter,
+        "pilatus_bc",
+        "-EA-PILAT-01:cam1:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )
+
+
+def pilatus_metadata(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> PilatusMetadata:
+    """A small pilatus driver device for figuring out the filename template."""
+    return device_instantiation(
+        PilatusMetadata,
+        "pilatus_meta",
+        "-EA-PILAT-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )

dodal/beamlines/p38.py

@@ -19,6 +19,7 @@ from dodal.devices.focusing_mirror import FocusingMirror
 from dodal.devices.i22.dcm import DoubleCrystalMonochromator
 from dodal.devices.i22.fswitch import FSwitch
 from dodal.devices.linkam3 import Linkam3
+from dodal.devices.pressure_jump_cell import PressureJumpCell
 from dodal.devices.slits import Slits
 from dodal.devices.tetramm import TetrammDetector
 from dodal.devices.undulator import Undulator
@@ -312,7 +313,7 @@ def linkam(
     return device_instantiation(
         Linkam3,
         "linkam",
-        "-EA-LINKM-02:",
+        f"{BeamlinePrefix(BL).insertion_prefix}-EA-LINKM-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
     )
@@ -329,3 +330,17 @@ def ppump(
         wait_for_connection,
         fake_with_ophyd_sim,
     )
+
+
+def high_pressure_xray_cell(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> PressureJumpCell:
+    return device_instantiation(
+        PressureJumpCell,
+        "high_pressure_xray_cell",
+        f"{BeamlinePrefix(BL).insertion_prefix}-EA",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+        cell_prefix="-HPXC-01:",
+        adc_prefix="-ADC",
+    )