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

dodal/beamlines/i11.py

@@ -1,25 +1,30 @@
+from pathlib import Path
+
+from ophyd_async.core import StaticPathProvider, UUIDFilenameProvider
+
 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.devices.cryostream import OxfordCryoStream
-from dodal.devices.eurotherm import (
-    EurothermGeneral,
-    UpdatingEurothermGeneral,
-)
-from dodal.devices.i11.cyberstar_blower import (
+from dodal.devices.beamlines.i11.cyberstar_blower import (
     AutotunedCyberstarBlower,
     CyberstarBlower,
 )
-from dodal.devices.i11.diff_stages import (
+from dodal.devices.beamlines.i11.diff_stages import (
     DiffractometerBase,
     DiffractometerStage,
 )
-from dodal.devices.i11.mythen import Mythen3
-from dodal.devices.i11.nx100robot import NX100Robot
-from dodal.devices.i11.spinner import Spinner
+from dodal.devices.beamlines.i11.mythen import Mythen3
+from dodal.devices.beamlines.i11.nx100robot import NX100Robot
+from dodal.devices.beamlines.i11.spinner import Spinner
+from dodal.devices.cryostream import OxfordCryoStream
+from dodal.devices.eurotherm import (
+    EurothermGeneral,
+    UpdatingEurothermGeneral,
+)
 from dodal.devices.slits import Slits
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
@@ -30,10 +35,17 @@ 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 mythen3() -> Mythen3:
-    """Mythen3 Detector from PSI"""
+    """Mythen3 Detector from PSI."""
     return Mythen3(
         prefix=f"{PREFIX.beamline_prefix}-EA-DET-07:",
         path_provider=get_path_provider(),
@@ -44,19 +56,19 @@ def mythen3() -> Mythen3:
 
 @device_factory()
 def ocs1() -> OxfordCryoStream:
-    """i11 Oxford Cryostream 700 plus without cryoshutter"""
+    """i11 Oxford Cryostream 700 plus without cryoshutter."""
     return OxfordCryoStream(f"{PREFIX.beamline_prefix}-CG-CSTRM-01:")
 
 
 @device_factory()
 def ocs2() -> OxfordCryoStream:
-    """i11 Oxford Cryostream 700 standard without cryoshutter"""
+    """i11 Oxford Cryostream 700 standard without cryoshutter."""
     return OxfordCryoStream(f"{PREFIX.beamline_prefix}-CG-CSTRM-02:")
 
 
 @device_factory()
 def diff_stage() -> DiffractometerStage:
-    """Stage that contains the rotation axes, theta, two_theta, delta, spos"""
+    """Stage that contains the rotation axes, theta, two_theta, delta, spos."""
     return DiffractometerStage(prefix=f"{PREFIX.beamline_prefix}-MO-DIFF-01:")
 
 
@@ -67,7 +79,7 @@ def diff_base() -> DiffractometerBase:
 
 @device_factory()
 def csb1() -> CyberstarBlower[UpdatingEurothermGeneral]:
-    """Cyberstar hot air blower 1 with Eurotherm Controller and updating PID"""
+    """Cyberstar hot air blower 1 with Eurotherm Controller and updating PID."""
     return CyberstarBlower(
         prefix=f"{PREFIX.beamline_prefix}-EA-BLOW-01:",
         controller_type=UpdatingEurothermGeneral,
@@ -76,7 +88,7 @@ def csb1() -> CyberstarBlower[UpdatingEurothermGeneral]:
 
 @device_factory()
 def csb2() -> AutotunedCyberstarBlower[EurothermGeneral]:
-    """Cyberstar hot air blower 2 with autotuneable Eurotherm Controller"""
+    """Cyberstar hot air blower 2 with autotuneable Eurotherm Controller."""
     return AutotunedCyberstarBlower(
         prefix=f"{PREFIX.beamline_prefix}-EA-BLOW-02:LOOP1:",
         controller_type=EurothermGeneral,
@@ -86,13 +98,14 @@ def csb2() -> AutotunedCyberstarBlower[EurothermGeneral]:
 @device_factory()
 def sample_robot() -> NX100Robot:
     """The sample robot arm and carosel on i11 that moves
-    and loads samples on/off the spinner"""
+    and loads samples on/off the spinner.
+    """
     return NX100Robot(prefix=f"{PREFIX.beamline_prefix}-EA-ROBOT-01:")
 
 
 @device_factory()
 def spinner() -> Spinner:
-    """Sample spinner for powder averaging"""
+    """Sample spinner for powder averaging."""
     return Spinner(prefix=f"{PREFIX.beamline_prefix}-EA-ENV-01:")
 
 

dodal/beamlines/i13_1.py

@@ -9,7 +9,7 @@ from dodal.common.beamlines.beamline_utils import (
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
-from dodal.devices.i13_1.merlin import Merlin
+from dodal.devices.beamlines.i13_1.merlin import Merlin
 from dodal.devices.motors import XYZStage
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name

dodal/beamlines/i15.py

@@ -2,15 +2,15 @@ from ophyd_async.epics.motor import Motor
 
 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.i15.dcm import DCM
-from dodal.devices.i15.focussing_mirror import (
+from dodal.devices.beamlines.i15.dcm import DCM
+from dodal.devices.beamlines.i15.focussing_mirror import (
     FocusingMirror,
     FocusingMirrorHorizontal,
     FocusingMirrorVertical,
     FocusingMirrorWithRoll,
 )
-from dodal.devices.i15.jack import JackX, JackY
-from dodal.devices.i15.motors import UpstreamDownstreamPair
+from dodal.devices.beamlines.i15.jack import JackX, JackY
+from dodal.devices.beamlines.i15.motors import UpstreamDownstreamPair
 from dodal.devices.motors import (
     SixAxisGonioKappaPhi,
     XYStage,
@@ -66,7 +66,7 @@ def det1z() -> Motor:
 
 @device_factory()
 def det2z() -> Motor:
-    """Deliberately the same as eht2dtx"""
+    """Deliberately the same as eht2dtx."""
     return Motor(f"{PREFIX.beamline_prefix}-MO-TABLE-03:DETECTOR2:Z")
 
 
@@ -85,7 +85,7 @@ def djack1() -> JackX:
 
 @device_factory()
 def eht2dtx() -> Motor:
-    """Deliberately the same as det2z"""
+    """Deliberately the same as det2z."""
     return Motor(f"{PREFIX.beamline_prefix}-MO-TABLE-03:DETECTOR2:Z")
 
 

dodal/beamlines/i15_1.py

@@ -2,10 +2,10 @@ from ophyd_async.epics.motor import Motor
 
 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.i15.laue import LaueMonochrometer
-from dodal.devices.i15.motors import NumberedTripleAxisStage
-from dodal.devices.i15.multilayer_mirror import MultiLayerMirror
-from dodal.devices.i15.rail import Rail
+from dodal.devices.beamlines.i15.laue import LaueMonochrometer
+from dodal.devices.beamlines.i15.motors import NumberedTripleAxisStage
+from dodal.devices.beamlines.i15.multilayer_mirror import MultiLayerMirror
+from dodal.devices.beamlines.i15.rail import Rail
 from dodal.devices.motors import XYPhiStage, XYStage, YZStage
 from dodal.devices.slits import Slits
 from dodal.devices.synchrotron import Synchrotron
@@ -41,13 +41,13 @@ def base_y() -> Motor:
 
 @device_factory()
 def blower_y() -> Motor:
-    """Same motor as blowerZ"""
+    """Same motor as blowerZ."""
     return Motor(f"{PREFIX.beamline_prefix}-EA-BLOWR-01:TLATE")
 
 
 @device_factory()
 def blower_z() -> Motor:
-    """Same motor as blowerY"""
+    """Same motor as blowerY."""
     return Motor(f"{PREFIX.beamline_prefix}-EA-BLOWR-01:TLATE")
 
 

dodal/beamlines/i17.py

@@ -1,13 +1,12 @@
 """The I17 hardware doesn't exist yet, but this configuration file is useful for
-creating plans in sm-bluesky as devices build up."""
+creating plans in sm-bluesky as devices build up.
+"""
 
 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.i17.i17_apple2 import I17Apple2Controller
+from dodal.device_manager import DeviceManager
+from dodal.devices.beamlines.i17.i17_apple2 import I17Apple2Controller
 from dodal.devices.insertion_device import (
     Apple2,
     Apple2Controller,
@@ -29,18 +28,20 @@ PREFIX = BeamlinePrefix(BL)
 set_log_beamline(BL)
 set_utils_beamline(BL)
 
+devices = DeviceManager()
+
 
 class I17Grating(StrictEnum):
     AU_400 = "400 line/mm Au"
     SI_400 = "400 line/mm Si"
 
 
-@device_factory()
+@devices.factory
 def synchrotron() -> Synchrotron:
     return Synchrotron()
 
 
-@device_factory(skip=True)
+@devices.factory(skip=True)
 def pgm() -> PlaneGratingMonochromator:
     return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
@@ -49,12 +50,12 @@ def pgm() -> PlaneGratingMonochromator:
     )
 
 
-@device_factory()
+@devices.factory(skip=True)
 def id_gap() -> UndulatorGap:
     return UndulatorGap(prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:")
 
 
-@device_factory()
+@devices.factory(skip=True)
 def id_phase() -> UndulatorPhaseAxes:
     return UndulatorPhaseAxes(
         prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
@@ -65,36 +66,44 @@ def id_phase() -> UndulatorPhaseAxes:
     )
 
 
-@device_factory(skip=True)
-def id() -> Apple2:
-    """I17 insertion device:"""
-    return Apple2(
-        id_gap=id_gap(),
-        id_phase=id_phase(),
+@devices.factory(skip=True)
+def id(
+    id_gap: UndulatorGap, id_phase: UndulatorPhaseAxes
+) -> Apple2[UndulatorPhaseAxes]:
+    return Apple2[UndulatorPhaseAxes](
+        id_gap=id_gap,
+        id_phase=id_phase,
     )
 
 
-@device_factory(skip=True)
-def id_controller() -> Apple2Controller:
+@devices.factory(skip=True)
+def id_controller(
+    id: Apple2[UndulatorPhaseAxes],
+) -> Apple2Controller[Apple2[UndulatorPhaseAxes]]:
     """I17 insertion device controller with dummy energy to motor_converter."""
     return I17Apple2Controller(
-        apple2=id(),
+        apple2=id,
         gap_energy_motor_lut=EnergyMotorLookup(lut=LookupTable()),
         phase_energy_motor_lut=EnergyMotorLookup(lut=LookupTable()),
     )
 
 
-@device_factory(skip=True)
-def id_energy() -> InsertionDeviceEnergy:
-    return InsertionDeviceEnergy(id_controller=id_controller())
+@devices.factory(skip=True)
+def id_energy(
+    id_controller: Apple2Controller[Apple2[UndulatorPhaseAxes]],
+) -> InsertionDeviceEnergy:
+    return InsertionDeviceEnergy(id_controller=id_controller)
 
 
-@device_factory(skip=True)
-def id_polarisation() -> InsertionDevicePolarisation:
-    return InsertionDevicePolarisation(id_controller=id_controller())
+@devices.factory(skip=True)
+def id_polarisation(
+    id_controller: Apple2Controller[Apple2[UndulatorPhaseAxes]],
+) -> InsertionDevicePolarisation:
+    return InsertionDevicePolarisation(id_controller=id_controller)
 
 
-@device_factory(skip=True)
-def energy() -> BeamEnergy:
-    """Beam energy."""
-    return BeamEnergy(id_energy=id_energy(), mono=pgm().energy)
+@devices.factory(skip=True)
+def energy(
+    id_energy: InsertionDeviceEnergy, pgm: PlaneGratingMonochromator
+) -> BeamEnergy:
+    return BeamEnergy(id_energy=id_energy, mono=pgm.energy)

dodal/beamlines/i18.py

@@ -12,13 +12,13 @@ from dodal.common.visit import (
     LocalDirectoryServiceClient,
     StaticVisitPathProvider,
 )
+from dodal.devices.beamlines.i18.diode import Diode
+from dodal.devices.beamlines.i18.kb_mirror import KBMirror
 from dodal.devices.common_dcm import (
     DoubleCrystalMonochromatorWithDSpacing,
     PitchAndRollCrystal,
     RollCrystal,
 )
-from dodal.devices.i18.diode import Diode
-from dodal.devices.i18.kb_mirror import KBMirror
 from dodal.devices.motors import XYStage, XYZThetaStage
 from dodal.devices.slits import Slits
 from dodal.devices.synchrotron import Synchrotron
@@ -60,8 +60,7 @@ def undulator() -> UndulatorInKeV:
 # See https://github.com/DiamondLightSource/dodal/issues/1180
 @device_factory(skip=True)
 def dcm() -> DoubleCrystalMonochromatorWithDSpacing:
-    """
-    A double crystal monocromator device, used to select the beam energy.
+    """A double crystal monocromator device, used to select the beam energy.
 
     Once spacing is added Si111 d-spacing is 3.135 angsterm , and Si311 is 1.637
     calculations are in gda/config/lookupTables/Si111/eV_Deg_converter.xml

dodal/beamlines/i19_1.py

@@ -1,20 +1,23 @@
-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.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 (
+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,
-    HutchState,
 )
-from dodal.devices.i19.beamstop import BeamStop
+from dodal.devices.beamlines.i19.beamstop import BeamStop
+from dodal.devices.beamlines.i19.pin_tip import PinTipCentreHolder
 from dodal.devices.oav.oav_detector import OAVBeamCentreFile
 from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
+from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
@@ -39,42 +42,80 @@ I19_1_ZEBRA_MAPPING = ZebraMapping(
     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"
+ZOOM_PARAMS_FILE = "/dls_sw/i19-1/software/bluesky/jCameraManZoomLevels.xml"
+DISPLAY_CONFIG = "/dls_sw/i19-1/software/bluesky/display.configuration"
+
+devices = DeviceManager()
 
 
-@device_factory()
+@devices.factory()
 def attenuator_motor_squad() -> AttenuatorMotorSquad:
     return AttenuatorMotorSquad(
         hutch=HutchState.EH1, instrument_session=I19_1_COMMISSIONING_INSTR_SESSION
     )
 
 
-# Needs to wait until enum is fixed on the beamline
-# See https://github.com/DiamondLightSource/dodal/issues/1150
-@device_factory()
+@devices.factory()
 def beamstop() -> BeamStop:
-    """Get the i19-1 beamstop 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 BeamStop(prefix=f"{PREFIX.beamline_prefix}-RS-ABSB-01:")
 
 
-@device_factory()
-def oav() -> OAVBeamCentreFile:
+@devices.fixture
+def oav_config() -> OAVConfigBeamCentre:
+    return OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG)
+
+
+@devices.factory()
+def oav1(oav_config: OAVConfigBeamCentre) -> OAVBeamCentreFile:
+    """The OAV1 camera, placed next to the beampipe along with the Zoom lens."""
     return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-EA-OAV-01:",
-        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=oav_config,
     )
 
 
-@device_factory()
+@devices.factory()
+def oav2(oav_config: OAVConfigBeamCentre) -> OAVBeamCentreFile:
+    """The OAV2 camera, placed diagonally to the sample. It has no FZoom."""
+    return OAVBeamCentreFile(
+        prefix=f"{PREFIX.beamline_prefix}-EA-OAV-02:",
+        config=oav_config,
+    )
+
+
+@devices.factory()
+def pin_tip_centre1() -> PinTipCentreHolder:
+    """I19-1 temporary device to hold the pin tip centre position for OAV1."""
+    return PinTipCentreHolder(
+        prefix=f"{PREFIX.beamline_prefix}-EA-OAV-01:",
+        overlay_channel=8,
+    )
+
+
+@devices.factory()
+def pin_tip_centre2() -> PinTipCentreHolder:
+    """I19-1 temporary device to hold the pin tip centre position for OAV2."""
+    return PinTipCentreHolder(
+        prefix=f"{PREFIX.beamline_prefix}-EA-OAV-02:",
+        overlay_channel=8,
+    )
+
+
+@devices.factory()
+def pin_tip_detection1() -> PinTipDetection:
+    """Pin tip detection device for OAV1 camera."""
+    return PinTipDetection(f"{PREFIX.beamline_prefix}-EA-OAV-01:")
+
+
+@devices.factory()
+def pin_tip_detection2() -> PinTipDetection:
+    """Pin tip detection device for OAV2 camera."""
+    return PinTipDetection(f"{PREFIX.beamline_prefix}-EA-OAV-02:")
+
+
+@devices.factory()
 def shutter() -> AccessControlledShutter:
-    """Get the i19-1 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.EH1,
@@ -82,22 +123,42 @@ def shutter() -> AccessControlledShutter:
     )
 
 
-@device_factory()
+@devices.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()
 
 
 # NOTE EH1 uses the Zebra 2 box. While a Zebra 1 box exists and is connected
 # on the beamline, it is currently not in use
-@device_factory()
+@devices.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,
         prefix=f"{PREFIX.beamline_prefix}-EA-ZEBRA-02:",
     )
+
+
+@devices.factory()
+def hfm_piezo() -> AccessControlledPiezoActuator:
+    """Get the i19-1 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.EH1,
+        instrument_session=I19_1_COMMISSIONING_INSTR_SESSION,
+    )
+
+
+@devices.factory()
+def vfm_piezo() -> AccessControlledPiezoActuator:
+    """Get the i19-1 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.EH1,
+        instrument_session=I19_1_COMMISSIONING_INSTR_SESSION,
+    )