dls-dodal 1.39.0__py3-none-any.whl → 1.41.0__py3-none-any.whl

dodal/beamlines/i19_1.py

@@ -0,0 +1,74 @@
+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.i19.shutter import HutchConditionalShutter, HutchState
+from dodal.devices.oav.oav_detector import OAV
+from dodal.devices.oav.oav_parameters import OAVConfig
+from dodal.devices.synchrotron import Synchrotron
+from dodal.devices.zebra.zebra import Zebra
+from dodal.devices.zebra.zebra_constants_mapping import (
+    ZebraMapping,
+    ZebraSources,
+    ZebraTTLOutputs,
+)
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+# NOTE All PVs for both hutches and the optics have the prefix BL19I
+BL = get_beamline_name("i19_1")
+PREFIX = BeamlinePrefix("i19", "I")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+I19_1_ZEBRA_MAPPING = ZebraMapping(
+    outputs=ZebraTTLOutputs(TTL_PILATUS=1),
+    sources=ZebraSources(),
+)
+
+ZOOM_PARAMS_FILE = (
+    "/dls_sw/i19-1/software/gda_versions/gda/config/xml/jCameraManZoomLevels.xml"
+)
+DISPLAY_CONFIG = "/dls_sw/i19-1/software/daq_configuration/domain/display.configuration"
+
+
+@device_factory()
+def oav() -> OAV:
+    return OAV(
+        prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
+        config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+    )
+
+
+@device_factory()
+def zebra() -> Zebra:
+    """Get the i19-1 zebra device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i19-1, it will return the existing object.
+    """
+    return Zebra(
+        mapping=I19_1_ZEBRA_MAPPING,
+        name="zebra",
+        prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-03:",
+    )
+
+
+@device_factory()
+def shutter() -> HutchConditionalShutter:
+    """Get the i19-2 hutch shutter device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return HutchConditionalShutter(
+        prefix=f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
+        hutch=HutchState.EH1,
+    )
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    """Get the i19-1 synchrotron device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i19-1, it will return the existing object.
+    """
+    return Synchrotron()

dodal/beamlines/i19_2.py

@@ -0,0 +1,61 @@
+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.i19.shutter import HutchConditionalShutter, HutchState
+from dodal.devices.synchrotron import Synchrotron
+from dodal.devices.zebra.zebra import Zebra
+from dodal.devices.zebra.zebra_constants_mapping import (
+    ZebraMapping,
+    ZebraSources,
+    ZebraTTLOutputs,
+)
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix
+
+# NOTE all workstations on I19 default to i19-1 as beamline name
+# Unless variable is exported (which is not usually done by scientists)
+# NOTE All PVs for both hutches and the optics have the prefix BL19I
+BL = "i19-2"
+PREFIX = BeamlinePrefix("i19", "I")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+I19_2_ZEBRA_MAPPING = ZebraMapping(
+    outputs=ZebraTTLOutputs(),
+    sources=ZebraSources(),
+)
+
+
+@device_factory()
+def zebra() -> Zebra:
+    """Get the i19-2 zebra device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i19-2, it will return the existing object.
+    """
+    return Zebra(
+        mapping=I19_2_ZEBRA_MAPPING,
+        name="zebra",
+        prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-01:",
+    )
+
+
+@device_factory()
+def shutter() -> HutchConditionalShutter:
+    """Get the i19-2 hutch shutter device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return HutchConditionalShutter(
+        prefix=f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
+        hutch=HutchState.EH2,
+    )
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    """Get the i19-2 synchrotron device, instantiate it if it hasn't already been.
+    If this is called when already instantiated in i19-2, it will return the existing object.
+    """
+    return Synchrotron()

dodal/beamlines/i20_1.py

@@ -1,43 +1,58 @@
-from dodal.common.beamlines.beamline_utils import device_instantiation
+from pathlib import Path
+
+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.devices.synchrotron import Synchrotron
 from dodal.devices.turbo_slit import TurboSlit
 from dodal.devices.xspress3.xspress3 import Xspress3
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import get_beamline_name
+from dodal.utils import BeamlinePrefix, get_beamline_name
 
-BL = get_beamline_name("i20_1")
+BL = get_beamline_name("i20-1")
+PREFIX = BeamlinePrefix(BL, suffix="J")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
 
-def turbo_slit(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> TurboSlit:
+# Currently we must hard-code the visit, determining the visit at runtime requires
+# infrastructure that is still WIP.
+# Communication with GDA is also WIP so for now we determine an arbitrary scan number
+# locally and write the commissioning directory. The scan number is not guaranteed to
+# be unique and the data is at risk - this configuration is for testing only.
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/dls/i20-1/data/2023/cm33897-5/bluesky"),
+        client=RemoteDirectoryServiceClient("http://i20-1-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def turbo_slit() -> TurboSlit:
     """
     turboslit for selecting energy from the polychromator
     """
 
-    return device_instantiation(
-        TurboSlit,
-        prefix="-OP-PCHRO-01:TS:",
-        name="turbo_slit",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
+    return TurboSlit(f"{PREFIX.beamline_prefix}-OP-PCHRO-01:TS:")
 
 
-def xspress3(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> Xspress3:
+@device_factory(skip=True)
+def xspress3() -> Xspress3:
     """
     16 channels Xspress3 detector
     """
 
-    return device_instantiation(
-        Xspress3,
-        prefix="-EA-DET-03:",
-        name="Xspress3",
+    return Xspress3(
+        f"{PREFIX.beamline_prefix}-EA-DET-03:",
         num_channels=16,
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
     )
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()

dodal/beamlines/i22.py

@@ -10,7 +10,7 @@ from dodal.common.beamlines.beamline_utils import (
     set_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.common.beamlines.device_helpers import HDF5_PREFIX
+from dodal.common.beamlines.device_helpers import CAM_SUFFIX, DET_SUFFIX, HDF5_SUFFIX
 from dodal.common.crystal_metadata import (
     MaterialsEnum,
     make_crystal_metadata_from_material,
@@ -63,8 +63,8 @@ def saxs() -> PilatusDetector:
     return NXSasPilatus(
         prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-01:",
         path_provider=get_path_provider(),
-        drv_suffix="CAM:",
-        hdf_suffix=HDF5_PREFIX,
+        drv_suffix=CAM_SUFFIX,
+        fileio_suffix=HDF5_SUFFIX,
         metadata_holder=metadata_holder,
     )
 
@@ -88,8 +88,8 @@ def waxs() -> PilatusDetector:
     return NXSasPilatus(
         prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-03:",
         path_provider=get_path_provider(),
-        drv_suffix="CAM:",
-        hdf_suffix=HDF5_PREFIX,
+        drv_suffix=CAM_SUFFIX,
+        fileio_suffix=HDF5_SUFFIX,
         metadata_holder=metadata_holder,
     )
 
@@ -248,8 +248,8 @@ def oav() -> AravisDetector:
     )
     return NXSasOAV(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        drv_suffix="DET:",
-        hdf_suffix=HDF5_PREFIX,
+        drv_suffix=DET_SUFFIX,
+        fileio_suffix=HDF5_SUFFIX,
         path_provider=get_path_provider(),
         metadata_holder=metadata_holder,
     )

dodal/beamlines/i23.py

@@ -1,13 +1,15 @@
-from dodal.common.beamlines.beamline_utils import device_instantiation
+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.oav.pin_image_recognition import PinTipDetection
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import get_beamline_name, get_hostname, skip_device
+from dodal.utils import BeamlinePrefix, get_beamline_name, get_hostname
 
 BL = get_beamline_name("i23")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+PREFIX = BeamlinePrefix(BL)
+
 
 def _is_i23_machine():
     """
@@ -18,16 +20,11 @@ def _is_i23_machine():
     return hostname.startswith("i23-ws") or hostname.startswith("i23-control")
 
 
-@skip_device(lambda: not _is_i23_machine())
-def oav_pin_tip_detection(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> PinTipDetection:
+@device_factory(skip=lambda: not _is_i23_machine())
+def oav_pin_tip_detection() -> PinTipDetection:
     """Get the i23 OAV pin-tip detection device"""
 
-    return device_instantiation(
-        PinTipDetection,
+    return PinTipDetection(
+        f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         "pin_tip_detection",
-        "-DI-OAV-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
     )

dodal/beamlines/i24.py

@@ -1,8 +1,9 @@
-from dodal.common.beamlines.beamline_utils import BL, device_instantiation
+from dodal.common.beamlines.beamline_utils import (
+    BL,
+    device_factory,
+)
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.attenuator.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
@@ -23,7 +24,7 @@ from dodal.devices.zebra.zebra_constants_mapping import (
     ZebraTTLOutputs,
 )
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import get_beamline_name, skip_device
+from dodal.utils import BeamlinePrefix, get_beamline_name
 
 ZOOM_PARAMS_FILE = (
     "/dls_sw/i24/software/gda_versions/gda/config/xml/jCameraManZoomLevels.xml"
@@ -40,234 +41,188 @@ I24_ZEBRA_MAPPING = ZebraMapping(
     sources=ZebraSources(),
 )
 
+PREFIX = BeamlinePrefix(BL)
+
 
-def attenuator(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> ReadOnlyAttenuator:
+@device_factory()
+def attenuator() -> 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,
+    return ReadOnlyAttenuator(
+        f"{PREFIX.beamline_prefix}-OP-ATTN-01:",
         "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:
+@device_factory()
+def aperture() -> Aperture:
     """Get the i24 aperture device, 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(
-        Aperture, "aperture", "-AL-APTR-01:", wait_for_connection, fake_with_ophyd_sim
+    return Aperture(
+        f"{PREFIX.beamline_prefix}-AL-APTR-01:",
+        "aperture",
     )
 
 
-def beamstop(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> Beamstop:
+@device_factory()
+def beamstop() -> Beamstop:
     """Get the i24 beamstop device, 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(
-        Beamstop,
+    return Beamstop(
+        f"{PREFIX.beamline_prefix}-MO-BS-01:",
         "beamstop",
-        "-MO-BS-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
     )
 
 
-def backlight(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> DualBacklight:
+@device_factory()
+def backlight() -> DualBacklight:
     """Get the i24 backlight device, 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(
-        device_factory=DualBacklight,
+    return DualBacklight(
+        prefix=PREFIX.beamline_prefix,
         name="backlight",
-        prefix="",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
     )
 
 
-def detector_motion(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> DetectorMotion:
+@device_factory()
+def detector_motion() -> DetectorMotion:
     """Get the i24 detector motion device, 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(
-        device_factory=DetectorMotion,
+    return DetectorMotion(
         name="detector_motion",
-        prefix="-EA-DET-01:",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
+        prefix=f"{PREFIX.beamline_prefix}-EA-DET-01:",
     )
 
 
-def dcm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> DCM:
+@device_factory()
+def dcm() -> DCM:
     """Get the i24 DCM device, 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(
-        device_factory=DCM,
+    return DCM(
         name="dcm",
-        prefix="",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-@skip_device(lambda: BL == "s24")
-def eiger(
-    wait_for_connection: bool = True,
-    fake_with_ophyd_sim: bool = False,
-    params: DetectorParams | None = None,
-) -> EigerDetector:
-    """Get the i24 Eiger device, instantiate it if it hasn't already been.
-    If this is called when already instantiated, it will return the existing object.
-    If called with params, will update those params to the Eiger object.
-    """
-
-    def set_params(eiger: EigerDetector):
-        if params is not None:
-            eiger.set_detector_parameters(params)
-
-    return device_instantiation(
-        device_factory=EigerDetector,
-        name="eiger",
-        prefix="-EA-EIGER-01:",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        post_create=set_params,
-    )
-
-
-def pmac(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> PMAC:
+        prefix=PREFIX.beamline_prefix,
+    )
+
+
+# TODO implement ophyd-async eiger see
+# https://github.com/DiamondLightSource/mx-bluesky/issues/62
+# @skip_device(lambda: BL == "s24")
+# def eiger(
+#     wait_for_connection: bool = True,
+#     fake_with_ophyd_sim: bool = False,
+#     params: DetectorParams | None = None,
+# ) -> EigerDetector:
+#     """Get the i24 Eiger device, instantiate it if it hasn't already been.
+#     If this is called when already instantiated, it will return the existing object.
+#     If called with params, will update those params to the Eiger object.
+#     """
+#
+#     def set_params(eiger: EigerDetector):
+#         if params is not None:
+#             eiger.set_detector_parameters(params)
+#
+#     return device_instantiation(
+#         device_factory=EigerDetector,
+#         name="eiger",
+#         prefix="-EA-EIGER-01:",
+#         wait=wait_for_connection,
+#         fake=fake_with_ophyd_sim,
+#         post_create=set_params,
+#     )
+
+
+@device_factory()
+def pmac() -> PMAC:
     """Get the i24 PMAC device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i24, it will return the existing object.
     """
     # prefix not BL but ME14E
-    return device_instantiation(
-        PMAC,
-        "pmac",
+    return PMAC(
         "ME14E-MO-CHIP-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
-        bl_prefix=False,
+        "pmac",
     )
 
 
-@skip_device(lambda: BL == "s24")
-def oav(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> OAV:
-    return device_instantiation(
-        OAV,
-        "oav",
-        "-DI-OAV-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+@device_factory(skip=BL == "s24")
+def oav() -> OAV:
+    return OAV(
+        prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
+        name="oav",
         config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
     )
 
 
-def vgonio(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> VerticalGoniometer:
+@device_factory()
+def vgonio() -> VerticalGoniometer:
     """Get the i24 vertical goniometer device, instantiate it if it hasn't already been.
     If this is called when already instantiated, it will return the existing object.
     """
-    return device_instantiation(
-        VerticalGoniometer,
+    return VerticalGoniometer(
+        f"{PREFIX.beamline_prefix}-MO-VGON-01:",
         "vgonio",
-        "-MO-VGON-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
     )
 
 
-def zebra(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> Zebra:
+@device_factory()
+def zebra() -> Zebra:
     """Get the i24 zebra device, 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(
-        Zebra,
-        "zebra",
-        "-EA-ZEBRA-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
+    return Zebra(
+        name="zebra",
+        prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-01:",
         mapping=I24_ZEBRA_MAPPING,
     )
 
 
-def shutter(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> HutchShutter:
+@device_factory()
+def shutter() -> HutchShutter:
     """Get the i24 hutch shutter device, instantiate it if it hasn't already been.
     If this is called when already instantiated, it will return the existing object.
     """
-    return device_instantiation(
-        HutchShutter,
+    return HutchShutter(
+        f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
         "shutter",
-        "-PS-SHTR-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
     )
 
 
-def focus_mirrors(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> FocusMirrorsMode:
+@device_factory()
+def focus_mirrors() -> FocusMirrorsMode:
     """Get the i24 focus mirror devise to find the beam size."""
-    return device_instantiation(
-        FocusMirrorsMode,
+    return FocusMirrorsMode(
+        f"{PREFIX.beamline_prefix}-OP-MFM-01:",
         "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:
+@device_factory()
+def eiger_beam_center() -> DetectorBeamCenter:
     """A device for setting/reading the beamcenter from the eiger on i24."""
-    return device_instantiation(
-        DetectorBeamCenter,
+    return DetectorBeamCenter(
+        f"{PREFIX.beamline_prefix}-EA-EIGER-01:CAM:",
         "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:
+@device_factory()
+def pilatus_beam_center() -> DetectorBeamCenter:
     """A device for setting/reading the beamcenter from the pilatus on i24."""
-    return device_instantiation(
-        DetectorBeamCenter,
+    return DetectorBeamCenter(
+        f"{PREFIX.beamline_prefix}-EA-PILAT-01:cam1:",
         "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:
+@device_factory()
+def pilatus_metadata() -> PilatusMetadata:
     """A small pilatus driver device for figuring out the filename template."""
-    return device_instantiation(
-        PilatusMetadata,
+    return PilatusMetadata(
+        f"{PREFIX.beamline_prefix}-EA-PILAT-01:",
         "pilatus_meta",
-        "-EA-PILAT-01:",
-        wait_for_connection,
-        fake_with_ophyd_sim,
     )