dls-dodal 1.68.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

dodal/beamlines/i19_2.py

@@ -1,26 +1,30 @@
+from functools import cache
 from pathlib import Path
 
+from ophyd_async.core import PathProvider
 from ophyd_async.fastcs.eiger import EigerDetector
 from ophyd_async.fastcs.panda import HDFPanda
 
-from dodal.common.beamlines.beamline_utils import (
-    device_factory,
-    get_path_provider,
-    set_path_provider,
-)
 from dodal.common.beamlines.beamline_utils import (
     set_beamline as set_utils_beamline,
 )
 from dodal.common.visit import StaticVisitPathProvider
-from dodal.devices.i19.access_controlled.attenuator_motor_squad import (
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i19.access_controlled.attenuator_motor_squad import (
     AttenuatorMotorSquad,
 )
-from dodal.devices.i19.access_controlled.blueapi_device import HutchState
-from dodal.devices.i19.access_controlled.shutter import AccessControlledShutter
-from dodal.devices.i19.backlight import BacklightPosition
-from dodal.devices.i19.beamstop import BeamStop
-from dodal.devices.i19.diffractometer import FourCircleDiffractometer
-from dodal.devices.i19.pin_col_stages import PinholeCollimatorControl
+from dodal.devices.beamlines.i19.access_controlled.blueapi_device import HutchState
+from dodal.devices.beamlines.i19.access_controlled.piezo_control import (
+    AccessControlledPiezoActuator,
+    FocusingMirrorName,
+)
+from dodal.devices.beamlines.i19.access_controlled.shutter import (
+    AccessControlledShutter,
+)
+from dodal.devices.beamlines.i19.backlight import BacklightPosition
+from dodal.devices.beamlines.i19.beamstop import BeamStop
+from dodal.devices.beamlines.i19.diffractometer import FourCircleDiffractometer
+from dodal.devices.beamlines.i19.pin_col_stages import PinholeCollimatorControl
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
@@ -39,13 +43,6 @@ PREFIX = BeamlinePrefix("i19", "I")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
-set_path_provider(
-    StaticVisitPathProvider(
-        BL,
-        Path("/dls/i19-2/data/2025/cm40639-4/"),
-    )
-)
-
 I19_2_COMMISSIONING_INSTR_SESSION: str = "cm40639-5"
 
 I19_2_ZEBRA_MAPPING = ZebraMapping(
@@ -53,67 +50,66 @@ I19_2_ZEBRA_MAPPING = ZebraMapping(
     sources=ZebraSources(),
 )
 
+devices = DeviceManager()
+
 
-@device_factory()
+@devices.fixture
+@cache
+def path_provider() -> PathProvider:
+    return StaticVisitPathProvider(
+        BL,
+        Path("/dls/i19-2/data/2026/cm44169-1/"),
+    )
+
+
+@devices.factory()
 def attenuator_motor_squad() -> AttenuatorMotorSquad:
     return AttenuatorMotorSquad(
         hutch=HutchState.EH2, instrument_session=I19_2_COMMISSIONING_INSTR_SESSION
     )
 
 
-@device_factory()
+@devices.factory()
 def backlight() -> BacklightPosition:
-    """Get the i19-2 backlight 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 BacklightPosition(prefix=f"{PREFIX.beamline_prefix}-EA-IOC-12:")
 
 
-@device_factory()
+@devices.factory()
 def beamstop() -> BeamStop:
-    """Get the i19-2 beamstop 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 BeamStop(prefix=f"{PREFIX.beamline_prefix}-OP-ABSB-02:")
 
 
-@device_factory()
+@devices.factory()
 def diffractometer() -> FourCircleDiffractometer:
     return FourCircleDiffractometer(prefix=PREFIX.beamline_prefix)
 
 
-@device_factory()
-def eiger() -> EigerDetector:
+@devices.factory()
+def eiger(path_provider: PathProvider) -> EigerDetector:
     return EigerDetector(
         prefix=PREFIX.beamline_prefix,
-        path_provider=get_path_provider(),
+        path_provider=path_provider,
         drv_suffix="-EA-EIGER-01:",
         hdf_suffix="-EA-EIGER-01:OD:",
     )
 
 
-@device_factory()
-def panda() -> HDFPanda:
+@devices.factory()
+def panda(path_provider: PathProvider) -> HDFPanda:
     return HDFPanda(
         prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-01:",
-        path_provider=get_path_provider(),
+        path_provider=path_provider,
     )
 
 
-@device_factory()
+@devices.factory()
 def pinhole_and_collimator() -> PinholeCollimatorControl:
-    """Get the i19-2 pinhole and collimator control 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 PinholeCollimatorControl(prefix=PREFIX.beamline_prefix)
 
 
-@device_factory()
+@devices.factory()
 def shutter() -> AccessControlledShutter:
-    """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.
-    """
+    """Access controlled wrapper for the experiment shutter."""
     return AccessControlledShutter(
         prefix=f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
         hutch=HutchState.EH2,
@@ -121,20 +117,40 @@ def shutter() -> AccessControlledShutter:
     )
 
 
-@device_factory()
+@devices.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()
 
 
-@device_factory()
+@devices.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,
         prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-03:",
     )
+
+
+@devices.factory()
+def hfm_piezo() -> AccessControlledPiezoActuator:
+    """Get the i19-2 access controlled hfm piezo device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return AccessControlledPiezoActuator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-HFM-01:",
+        mirror_type=FocusingMirrorName.HFM,
+        hutch=HutchState.EH2,
+        instrument_session=I19_2_COMMISSIONING_INSTR_SESSION,
+    )
+
+
+@devices.factory()
+def vfm_piezo() -> AccessControlledPiezoActuator:
+    """Get the i19-2 access controlled vfm piezo device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return AccessControlledPiezoActuator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-VFM-01:",
+        mirror_type=FocusingMirrorName.VFM,
+        hutch=HutchState.EH2,
+        instrument_session=I19_2_COMMISSIONING_INSTR_SESSION,
+    )

dodal/beamlines/i19_optics.py

@@ -1,14 +1,13 @@
-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.hutch_shutter import HutchShutter
-from dodal.devices.i19.access_controlled.hutch_access import (
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i19.access_controlled.hutch_access import (
     ACCESS_DEVICE_NAME,
     HutchAccessControl,
 )
+from dodal.devices.focusing_mirror import FocusingMirrorWithPiezo
+from dodal.devices.hutch_shutter import HutchShutter
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix
 
@@ -17,20 +16,34 @@ PREFIX = BeamlinePrefix("i19", "I")
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+
 
-@device_factory()
+@devices.factory()
 def shutter() -> HutchShutter:
-    """Get the i19 hutch shutter device, instantiate it if it hasn't already been.
-    If this is called when already instantiated, it will return the existing object.
-    """
+    """Real experiment shutter device for I19."""
     return HutchShutter(f"{PREFIX.beamline_prefix}-PS-SHTR-01:")
 
 
-@device_factory()
+@devices.factory()
 def access_control() -> HutchAccessControl:
-    """Get a device that checks the active hutch for i19, instantiate it if it hasn't already been.
-    If this is called when already instantiated, it will return the existing object.
-    """
+    """Device to check which hutch is the active hutch on i19."""
     return HutchAccessControl(
         f"{PREFIX.beamline_prefix}-OP-STAT-01:", ACCESS_DEVICE_NAME
     )
+
+
+@devices.factory()
+def vfm() -> FocusingMirrorWithPiezo:
+    """Get the i19 vfm device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return FocusingMirrorWithPiezo(f"{PREFIX.beamline_prefix}-OP-VFM-01:")
+
+
+@devices.factory()
+def hfm() -> FocusingMirrorWithPiezo:
+    """Get the i19 hfm device, instantiate it if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object.
+    """
+    return FocusingMirrorWithPiezo(f"{PREFIX.beamline_prefix}-OP-HFM-01:")

dodal/beamlines/i20_1.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 from ophyd_async.epics.motor import Motor
+from ophyd_async.epics.pmac import PmacIO
 from ophyd_async.fastcs.panda import HDFPanda
 
 from dodal.common.beamlines.beamline_utils import (
@@ -37,27 +38,34 @@ set_path_provider(
 """
 NOTE: Due to the CA gateway machine being switched off, PVs are not available remotely
 and you need to be on the beamline network to access them.
-The simplest way to do this is to `ssh i20-1-ws001` and run dodal connect i20_1 from there.
+The simplest way to do this is to `ssh i20-1-ws001` and run dodal connect i20_1 from
+there.
 """
 
 
 @device_factory()
 def turbo_slit() -> TurboSlit:
-    """
-    turboslit for selecting energy from the polychromator
-    """
-
+    """Turboslit for selecting energy from the polychromator."""
     return TurboSlit(f"{PREFIX.beamline_prefix}-OP-PCHRO-01:TS:")
 
 
 @device_factory()
 def turbo_slit_x() -> Motor:
-    """
-    turbo slit x motor
-    """
+    """Turbo slit x motor."""
     return Motor(f"{PREFIX.beamline_prefix}-OP-PCHRO-01:TS:XFINE")
 
 
+@device_factory()
+def turbo_slit_pmac() -> PmacIO:
+    """PMac controller using running fly scans with trajectory."""
+    motor = turbo_slit_x()
+    return PmacIO(
+        prefix=f"{PREFIX.beamline_prefix}-MO-STEP-06:",
+        raw_motors=[motor],
+        coord_nums=[3],
+    )
+
+
 @device_factory()
 def panda() -> HDFPanda:
     return HDFPanda(
@@ -79,9 +87,7 @@ def alignment_y() -> Motor:
 
 @device_factory(skip=True)
 def xspress3() -> Xspress3:
-    """
-    16 channels Xspress3 detector
-    """
+    """16 channels Xspress3 detector."""
     return Xspress3(
         f"{PREFIX.beamline_prefix}-EA-DET-03:",
         num_channels=16,

dodal/beamlines/i21.py

@@ -2,13 +2,9 @@ from pathlib import Path
 
 from daq_config_server.client import ConfigServer
 
-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.i21 import (
-    Grating,
-)
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i21 import Grating
 from dodal.devices.insertion_device import (
     Apple2,
     Apple2EnforceLHMoveController,
@@ -24,6 +20,9 @@ from dodal.devices.insertion_device.energy_motor_lookup import (
 from dodal.devices.insertion_device.lookup_table_models import LookupTableColumnConfig
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
+from dodal.devices.temperture_controller import (
+    Lakeshore336,
+)
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -39,14 +38,15 @@ I21_CONF_CLIENT = ConfigServer(url="https://daq-config.diamond.ac.uk")
 LOOK_UPTABLE_DIR = "/dls_sw/i21/software/gda/workspace_git/gda-diamond.git/configurations/i21-config/lookupTables/"
 GAP_LOOKUP_FILE_NAME = "IDEnergy2GapCalibrations.csv"
 PHASE_LOOKUP_FILE_NAME = "IDEnergy2PhaseCalibrations.csv"
+devices = DeviceManager()
 
 
-@device_factory()
+@devices.factory()
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
 
-@device_factory()
+@devices.factory()
 def pgm() -> PlaneGratingMonochromator:
     return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
@@ -54,12 +54,12 @@ def pgm() -> PlaneGratingMonochromator:
     )
 
 
-@device_factory()
+@devices.factory()
 def id_gap() -> UndulatorGap:
     return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
 
 
-@device_factory()
+@devices.factory()
 def id_phase() -> UndulatorPhaseAxes:
     return UndulatorPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
@@ -70,20 +70,24 @@ def id_phase() -> UndulatorPhaseAxes:
     )
 
 
-@device_factory()
-def id() -> Apple2:
+@devices.factory()
+def id(
+    id_gap: UndulatorGap, id_phase: UndulatorPhaseAxes
+) -> Apple2[UndulatorPhaseAxes]:
     """I21 insertion device."""
-    return Apple2(
-        id_gap=id_gap(),
-        id_phase=id_phase(),
+    return Apple2[UndulatorPhaseAxes](
+        id_gap=id_gap,
+        id_phase=id_phase,
     )
 
 
-@device_factory()
-def id_controller() -> Apple2EnforceLHMoveController:
-    """i21 insertion device controller."""
-    return Apple2EnforceLHMoveController(
-        apple2=id(),
+@devices.factory()
+def id_controller(
+    id: Apple2[UndulatorPhaseAxes],
+) -> Apple2EnforceLHMoveController[UndulatorPhaseAxes]:
+    """I21 insertion device controller."""
+    return Apple2EnforceLHMoveController[UndulatorPhaseAxes](
+        apple2=id,
         gap_energy_motor_lut=ConfigServerEnergyMotorLookup(
             lut_config=LookupTableColumnConfig(grating=I21_GRATING_COLUMNS),
             config_client=I21_CONF_CLIENT,
@@ -100,17 +104,28 @@ def id_controller() -> Apple2EnforceLHMoveController:
     )
 
 
-@device_factory()
-def id_energy() -> InsertionDeviceEnergy:
-    return InsertionDeviceEnergy(id_controller=id_controller())
+@devices.factory()
+def id_energy(
+    id_controller: Apple2EnforceLHMoveController[UndulatorPhaseAxes],
+) -> InsertionDeviceEnergy:
+    return InsertionDeviceEnergy(id_controller=id_controller)
 
 
-@device_factory()
-def id_polarisation() -> InsertionDevicePolarisation:
-    return InsertionDevicePolarisation(id_controller=id_controller())
+@devices.factory()
+def id_polarisation(
+    id_controller: Apple2EnforceLHMoveController[UndulatorPhaseAxes],
+) -> InsertionDevicePolarisation:
+    return InsertionDevicePolarisation(id_controller=id_controller)
 
 
-@device_factory()
-def energy_jid() -> BeamEnergy:
+@devices.factory()
+def energy(
+    id_energy: InsertionDeviceEnergy, pgm: PlaneGratingMonochromator
+) -> BeamEnergy:
     """Beam energy."""
-    return BeamEnergy(id_energy=id_energy(), mono=pgm().energy)
+    return BeamEnergy(id_energy=id_energy, mono=pgm.energy)
+
+
+@devices.factory()
+def sample_temperature_controller() -> Lakeshore336:
+    return Lakeshore336(prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-01:")

dodal/beamlines/i22.py

@@ -1,3 +1,6 @@
+from pathlib import Path
+
+from ophyd_async.core import StaticPathProvider, UUIDFilenameProvider
 from ophyd_async.epics.adaravis import AravisDetector
 from ophyd_async.epics.adcore import NDPluginBaseIO, NDPluginStatsIO
 from ophyd_async.epics.adpilatus import PilatusDetector
@@ -6,6 +9,7 @@ from ophyd_async.fastcs.panda import HDFPanda
 from dodal.common.beamlines.beamline_utils import (
     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 CAM_SUFFIX, DET_SUFFIX, HDF5_SUFFIX
@@ -13,11 +17,15 @@ from dodal.common.crystal_metadata import (
     MaterialsEnum,
     make_crystal_metadata_from_material,
 )
+from dodal.devices.beamlines.i22.dcm import DCM
+from dodal.devices.beamlines.i22.fswitch import FSwitch
+from dodal.devices.beamlines.i22.nxsas import (
+    NXSasMetadataHolder,
+    NXSasOAV,
+    NXSasPilatus,
+)
 from dodal.devices.bimorph_mirror import BimorphMirror
 from dodal.devices.focusing_mirror import FocusingMirror
-from dodal.devices.i22.dcm import DCM
-from dodal.devices.i22.fswitch import FSwitch
-from dodal.devices.i22.nxsas import NXSasMetadataHolder, NXSasOAV, NXSasPilatus
 from dodal.devices.linkam3 import Linkam3
 from dodal.devices.motors import XYPitchStage, XYRollStage, XYStage
 from dodal.devices.slits import Slits
@@ -33,6 +41,13 @@ PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+# This should be removed when the DeviceManager is adopted
+try:
+    get_path_provider()
+except NameError:
+    # If one hasn't already been set, use a default to stop things crashing
+    set_path_provider(StaticPathProvider(UUIDFilenameProvider(), Path("/tmp")))
+
 
 @device_factory()
 def saxs() -> PilatusDetector:
@@ -267,7 +282,7 @@ def linkam() -> Linkam3:
 
 @device_factory(skip=True)
 def ppump() -> WatsonMarlow323Pump:
-    """Sample Environment Peristaltic Pump"""
+    """Sample Environment Peristaltic Pump."""
     return WatsonMarlow323Pump(f"{PREFIX.beamline_prefix}-EA-PUMP-01:")
 
 

dodal/beamlines/i23.py

@@ -1,16 +1,13 @@
+from functools import cache
 from pathlib import Path
 
-from ophyd_async.core import InOut, StrictEnum
+from ophyd_async.core import InOut, PathProvider, StrictEnum
 from ophyd_async.epics.adpilatus import PilatusDetector
 
-from dodal.common.beamlines.beamline_utils import (
-    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 HDF5_SUFFIX
 from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
+from dodal.device_manager import DeviceManager
 from dodal.devices.motors import SixAxisGonio
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.devices.positioner import Positioner1D
@@ -25,18 +22,22 @@ from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name, get_hostname
 
 BL = get_beamline_name("i23")
+PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
-set_path_provider(
-    StaticVisitPathProvider(
+devices = DeviceManager()
+
+
+@devices.fixture
+@cache
+def path_provider() -> PathProvider:
+    return StaticVisitPathProvider(
         BL,
         Path("/tmp"),
         client=LocalDirectoryServiceClient(),
     )
-)
 
-PREFIX = BeamlinePrefix(BL)
 
 I23_ZEBRA_MAPPING = ZebraMapping(
     outputs=ZebraTTLOutputs(TTL_DETECTOR=1, TTL_SHUTTER=4),
@@ -51,59 +52,51 @@ class I23DetectorPositions(StrictEnum):
 
 
 def _is_i23_machine():
-    """
-    Devices using PVA can only connect from i23 machines, due to the absence of
+    """Devices using PVA can only connect from i23 machines, due to the absence of
     PVA gateways at present.
     """
     hostname = get_hostname()
     return hostname.startswith("i23-ws") or hostname.startswith("i23-control")
 
 
-@device_factory(skip=lambda: not _is_i23_machine())
+@devices.factory(skip=lambda: not _is_i23_machine())
 def oav_pin_tip_detection() -> PinTipDetection:
-    """Get the i23 OAV pin-tip detection device."""
-
     return PinTipDetection(
         f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         "pin_tip_detection",
     )
 
 
-@device_factory()
+@devices.factory()
 def shutter() -> ZebraShutter:
-    """Get the i23 zebra controlled shutter."""
     return ZebraShutter(f"{PREFIX.beamline_prefix}-EA-SHTR-01:")
 
 
-@device_factory()
+@devices.factory()
 def gonio() -> SixAxisGonio:
-    """Get the i23 goniometer"""
     return SixAxisGonio(f"{PREFIX.beamline_prefix}-MO-GONIO-01:")
 
 
-@device_factory()
+@devices.factory()
 def zebra() -> Zebra:
-    """Get the i23 zebra"""
     return Zebra(
         prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-01:ZEBRA:",
         mapping=I23_ZEBRA_MAPPING,
     )
 
 
-@device_factory()
-def pilatus() -> PilatusDetector:
-    """Get the i23 pilatus"""
+@devices.factory()
+def pilatus(path_provider: PathProvider) -> PilatusDetector:
     return PilatusDetector(
         prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-01:",
-        path_provider=get_path_provider(),
+        path_provider=path_provider,
         drv_suffix="cam1:",
         fileio_suffix=HDF5_SUFFIX,
     )
 
 
-@device_factory()
+@devices.factory()
 def detector_motion() -> Positioner1D[I23DetectorPositions]:
-    """Get the i23 detector"""
     return Positioner1D[I23DetectorPositions](
         f"{PREFIX.beamline_prefix}-EA-DET-01:Z",
         datatype=I23DetectorPositions,