dls-dodal 1.57.0__py3-none-any.whl → 1.59.1__py3-none-any.whl

dodal/beamlines/i09_1.py

@@ -2,8 +2,8 @@ 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 import SelectedSource
-from dodal.devices.electron_analyser.specs import SpecsAnalyserDriverIO
+from dodal.devices.electron_analyser import EnergySource
+from dodal.devices.electron_analyser.specs import SpecsDetector
 from dodal.devices.i09.dcm import DCM
 from dodal.devices.i09_1 import LensMode, PsuMode
 from dodal.devices.synchrotron import Synchrotron
@@ -26,13 +26,18 @@ def dcm() -> DCM:
     return DCM(prefix=f"{PREFIX.beamline_prefix}-MO-DCM-01:")
 
 
+@device_factory()
+def energy_source() -> EnergySource:
+    return EnergySource(dcm().energy_in_ev)
+
+
 # Connect will work again after this work completed
 # https://jira.diamond.ac.uk/browse/I09-651
 @device_factory()
-def analyser_driver() -> SpecsAnalyserDriverIO[LensMode, PsuMode]:
-    return SpecsAnalyserDriverIO[LensMode, PsuMode](
+def analyser() -> SpecsDetector[LensMode, PsuMode]:
+    return SpecsDetector[LensMode, PsuMode](
         prefix=f"{PREFIX.beamline_prefix}-EA-DET-02:CAM:",
         lens_mode_type=LensMode,
         psu_mode_type=PsuMode,
-        energy_sources={SelectedSource.SOURCE1: dcm().energy_in_ev},
+        energy_source=energy_source(),
     )

dodal/beamlines/i10-1.py

@@ -0,0 +1,25 @@
+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.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
+
+BL = get_beamline_name("i10-1")
+PREFIX = BeamlinePrefix(BL, suffix="J")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
+
+
+@device_factory()
+def em_temperature_controller() -> Lakeshore336:
+    return Lakeshore336(
+        prefix=f"{PREFIX.beamline_prefix}-EA-TCTRL-41:",
+    )

dodal/beamlines/i10.py

@@ -6,6 +6,8 @@ note:
     idd == id1,    idu == id2.
 """
 
+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.current_amplifiers import CurrentAmpDet
@@ -25,6 +27,9 @@ from dodal.devices.i10.rasor.rasor_scaler_cards import RasorScalerCard1
 from dodal.devices.i10.slits import I10Slits, I10SlitsDrainCurrent
 from dodal.devices.motors import XYStage, XYZStage
 from dodal.devices.pgm import PGM
+from dodal.devices.temperture_controller import (
+    Lakeshore340,
+)
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -33,8 +38,10 @@ set_log_beamline(BL)
 set_utils_beamline(BL)
 PREFIX = BeamlinePrefix(BL)
 
+I10_CONF_CLIENT = ConfigServer(url="https://daq-config.diamond.ac.uk")
 
-LOOK_UPTABLE_DIR = "/dls_sw/i10/software/blueapi/scratch/i10-config/lookupTables/"
+
+LOOK_UPTABLE_DIR = "/dls_sw/i10/software/gda/workspace_git/gda-diamond.git/configurations/i10-shared/lookupTables/"
 
 
 @device_factory()
@@ -60,6 +67,7 @@ def idd() -> I10Id:
         pgm=pgm(),
         look_up_table_dir=LOOK_UPTABLE_DIR,
         source=("Source", "idd"),
+        config_client=I10_CONF_CLIENT,
     )
 
 
@@ -76,6 +84,7 @@ def idu() -> I10Id:
         pgm=pgm(),
         look_up_table_dir=LOOK_UPTABLE_DIR,
         source=("Source", "idu"),
+        config_client=I10_CONF_CLIENT,
     )
 
 
@@ -153,6 +162,13 @@ def sample_stage() -> XYZStage:
     return XYZStage(prefix="ME01D-MO-CRYO-01:")
 
 
+@device_factory()
+def rasor_temperature_controller() -> Lakeshore340:
+    return Lakeshore340(
+        prefix="ME01D-EA-TCTRL-01:",
+    )
+
+
 @device_factory()
 def rasor_femto() -> RasorFemto:
     return RasorFemto(

dodal/beamlines/i11.py

@@ -1,13 +1,9 @@
-from pathlib import Path
-
 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 DET_SUFFIX
-from dodal.common.visit import RemoteDirectoryServiceClient, StaticVisitPathProvider
 from dodal.devices.cryostream import OxfordCryoStream
 from dodal.devices.eurotherm import (
     EurothermGeneral,
@@ -34,19 +30,6 @@ PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
-# 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(f"/dls/{BL}/data/2025/cm40625-3/bluesky"),
-        client=RemoteDirectoryServiceClient(f"http://{BL}-control:8088/api"),
-    )
-)
-
 
 @device_factory()
 def mythen3() -> Mythen3:

dodal/beamlines/i19_2.py

@@ -1,9 +1,13 @@
+from ophyd_async.fastcs.panda import HDFPanda
+
 from dodal.common.beamlines.beamline_utils import (
     device_factory,
+    get_path_provider,
 )
 from dodal.common.beamlines.beamline_utils import (
     set_beamline as set_utils_beamline,
 )
+from dodal.devices.i19.backlight import BacklightPosition
 from dodal.devices.i19.beamstop import BeamStop
 from dodal.devices.i19.blueapi_device import HutchState
 from dodal.devices.i19.diffractometer import FourCircleDiffractometer
@@ -75,3 +79,19 @@ def synchrotron() -> Synchrotron:
     If this is called when already instantiated in i19-2, it will return the existing object.
     """
     return Synchrotron()
+
+
+@device_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()
+def panda() -> HDFPanda:
+    return HDFPanda(
+        prefix=f"{PREFIX.beamline_prefix}-EA-PANDA-01:",
+        path_provider=get_path_provider(),
+    )

dodal/beamlines/i21.py

@@ -0,0 +1,27 @@
+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.devices.pgm import PGM
+from dodal.devices.synchrotron import Synchrotron
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("i21")
+PREFIX = BeamlinePrefix(BL, suffix="I")
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
+
+
+@device_factory()
+def pgm() -> PGM:
+    return PGM(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )

dodal/beamlines/i22.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from ophyd_async.epics.adaravis import AravisDetector
-from ophyd_async.epics.adcore import NDPluginBaseIO
+from ophyd_async.epics.adcore import NDPluginBaseIO, NDPluginStatsIO
 from ophyd_async.epics.adpilatus import PilatusDetector
 from ophyd_async.fastcs.panda import HDFPanda
 
@@ -68,6 +68,11 @@ def saxs() -> PilatusDetector:
         drv_suffix=CAM_SUFFIX,
         fileio_suffix=HDF5_SUFFIX,
         metadata_holder=metadata_holder,
+        plugins={
+            "stats": NDPluginStatsIO(
+                prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-01:STAT:"
+            )
+        },
     )
 
 
@@ -93,6 +98,11 @@ def waxs() -> PilatusDetector:
         drv_suffix=CAM_SUFFIX,
         fileio_suffix=HDF5_SUFFIX,
         metadata_holder=metadata_holder,
+        plugins={
+            "stats": NDPluginStatsIO(
+                prefix=f"{PREFIX.beamline_prefix}-EA-PILAT-03:STAT:"
+            )
+        },
     )
 
 
@@ -272,7 +282,7 @@ def linkam() -> Linkam3:
     return Linkam3(prefix=f"{PREFIX.beamline_prefix}-EA-TEMPC-05:")
 
 
-@device_factory()
+@device_factory(skip=True)
 def ppump() -> WatsonMarlow323Pump:
     """Sample Environment Peristaltic Pump"""
     return WatsonMarlow323Pump(f"{PREFIX.beamline_prefix}-EA-PUMP-01:")

dodal/beamlines/i24.py

@@ -1,13 +1,22 @@
+from pathlib import PurePath
+
+from ophyd_async.core import AutoIncrementingPathProvider, StaticFilenameProvider
+
 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.attenuator.attenuator import EnumFilterAttenuator
+from dodal.devices.attenuator.filter_selections import (
+    I24_FilterOneSelections,
+    I24_FilterTwoSelections,
+)
 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.commissioning_jungfrau import CommissioningJungfrau
 from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import DualBacklight
 from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
@@ -44,12 +53,13 @@ PREFIX = BeamlinePrefix(BL)
 
 
 @device_factory()
-def attenuator() -> ReadOnlyAttenuator:
+def attenuator() -> EnumFilterAttenuator:
     """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 ReadOnlyAttenuator(
+    return EnumFilterAttenuator(
         f"{PREFIX.beamline_prefix}-OP-ATTN-01:",
+        filter_selection=(I24_FilterOneSelections, I24_FilterTwoSelections),
     )
 
 
@@ -187,3 +197,22 @@ def eiger_beam_center() -> DetectorBeamCenter:
         f"{PREFIX.beamline_prefix}-EA-EIGER-01:CAM:",
         "eiger_bc",
     )
+
+
+@device_factory()
+def commissioning_jungfrau(
+    path_to_dir: str = "/tmp/jf",  # Device factory doesn't allow for required args,
+    filename: str = "jf_output",  # but these should be manually entered when commissioning
+) -> CommissioningJungfrau:
+    """Get the commissionning Jungfrau 9M device, which uses a temporary filewriter
+    device in place of Odin while the detector is in commissioning.
+    Instantiates the device if it hasn't already been.
+    If this is called when already instantiated, it will return the existing object."""
+
+    return CommissioningJungfrau(
+        f"{PREFIX.beamline_prefix}-EA-JFRAU-01:",
+        f"{PREFIX.beamline_prefix}-JUNGFRAU-META:FD:",
+        AutoIncrementingPathProvider(
+            StaticFilenameProvider(filename), PurePath(path_to_dir)
+        ),
+    )

dodal/beamlines/k07.py

@@ -0,0 +1,31 @@
+from ophyd_async.core import StrictEnum
+
+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.pgm import PGM
+from dodal.devices.synchrotron import Synchrotron
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+BL = get_beamline_name("k07")
+PREFIX = BeamlinePrefix(BL)
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+
+@device_factory()
+def synchrotron() -> Synchrotron:
+    return Synchrotron()
+
+
+# Grating does not exist yet - this class is a placeholder for when it does
+class Grating(StrictEnum):
+    NO_GRATING = "No Grating"
+
+
+# Grating does not exist yet - this class is a placeholder for when it does
+@device_factory(skip=True)
+def pgm() -> PGM:
+    return PGM(prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:", grating=Grating)

dodal/beamlines/p60.py

@@ -2,8 +2,8 @@ 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 import SelectedSource
-from dodal.devices.electron_analyser.vgscienta import VGScientaAnalyserDriverIO
+from dodal.devices.electron_analyser import DualEnergySource
+from dodal.devices.electron_analyser.vgscienta import VGScientaDetector
 from dodal.devices.p60 import (
     LabXraySource,
     LabXraySourceReadable,
@@ -30,18 +30,19 @@ def mg_kalpha_source() -> LabXraySourceReadable:
     return LabXraySourceReadable(LabXraySource.MG_KALPHA)
 
 
+@device_factory()
+def energy_source() -> DualEnergySource:
+    return DualEnergySource(al_kalpha_source().energy_ev, mg_kalpha_source().energy_ev)
+
+
 # Connect will work again after this work completed
 # https://jira.diamond.ac.uk/browse/P60-13
 @device_factory()
-def analyser_driver() -> VGScientaAnalyserDriverIO[LensMode, PsuMode, PassEnergy]:
-    energy_sources = {
-        SelectedSource.SOURCE1: al_kalpha_source().energy_ev,
-        SelectedSource.SOURCE2: mg_kalpha_source().energy_ev,
-    }
-    return VGScientaAnalyserDriverIO[LensMode, PsuMode, PassEnergy](
+def r4000() -> VGScientaDetector[LensMode, PsuMode, PassEnergy]:
+    return VGScientaDetector[LensMode, PsuMode, PassEnergy](
         prefix=f"{PREFIX.beamline_prefix}-EA-DET-01:CAM:",
         lens_mode_type=LensMode,
         psu_mode_type=PsuMode,
         pass_energy_type=PassEnergy,
-        energy_sources=energy_sources,
+        energy_source=energy_source(),
     )

dodal/common/beamlines/commissioning_mode.py

@@ -0,0 +1,33 @@
+"""Functions relating to commissioning mode.
+
+Commissioning Mode can be enabled for a production beamline when there is no
+beam. The intent is that when it is enabled, bluesky plans may be run without beam
+and plans and devices will as far as is possible behave normally.
+"""
+
+import bluesky.plan_stubs as bps
+from bluesky.utils import MsgGenerator
+from ophyd_async.core import SignalR
+
+_commissioning_signal: SignalR | None = None
+
+
+def read_commissioning_mode() -> MsgGenerator[bool]:
+    """Utility method for reading the commissioning mode state from the context
+    of a bluesky plan, where a baton may or may not be present, or
+    commissioning mode is provided by some other mechanism."""
+    if _commissioning_signal:
+        return (yield from bps.rd(_commissioning_signal))
+    else:
+        return False
+
+
+def set_commissioning_signal(signal: SignalR[bool] | None):
+    """Commissioning mode is enabled by a PV which when set enables commissioning mode.
+    This allows beamline staff to ensure that commissioning mode is disabled prior
+    to production use, via their own 'good morning' startup scripts.
+    Args:
+        signal: The signal which will be read in order to determine whether
+        commissioning mode is enabled."""
+    global _commissioning_signal
+    _commissioning_signal = signal

dodal/common/watcher_utils.py

@@ -12,7 +12,6 @@ class _LogOnPercentageProgressWatcher(Watcher[Number]):
         message_prefix: str,
         percent_interval: Number = 25,
     ):
-        status.watch(self)
         self.percent_interval = percent_interval
         self._current_percent_interval = 0
         self.message_prefix = message_prefix
@@ -20,6 +19,7 @@ class _LogOnPercentageProgressWatcher(Watcher[Number]):
             raise ValueError(
                 f"Percent interval on class _LogOnPercentageProgressWatcher must be a positive number, but received {self.percent_interval}"
             )
+        status.watch(self)
 
     def __call__(
         self,