dls-dodal 1.47.0__py3-none-any.whl → 1.49.0__py3-none-any.whl

dodal/beamlines/i10.py

@@ -1,19 +1,17 @@
-from pathlib import Path
+"""
+note:
+    I10 has two insertion devices one up(idu) and one down stream(idd).
+    It is worth noting that the downstream device is slightly longer,
+    so it can reach Mn edge for linear arbitrary.
+    idd == id1,    idu == id2.
+"""
 
-from dodal.common.beamlines.beamline_utils import device_factory, 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.apple2_undulator import (
-    UndulatorGap,
-    UndulatorJawPhase,
-    UndulatorPhaseAxes,
-)
 from dodal.devices.current_amplifiers import CurrentAmpDet
 from dodal.devices.i10.diagnostics import I10Diagnostic, I10Diagnostic5ADet
 from dodal.devices.i10.i10_apple2 import (
-    I10Apple2,
-    I10Apple2PGM,
-    I10Apple2Pol,
-    LinearArbitraryAngle,
+    I10Id,
 )
 from dodal.devices.i10.i10_setting_data import I10Grating
 from dodal.devices.i10.mirrors import PiezoMirror
@@ -37,238 +35,48 @@ set_utils_beamline(BL)
 PREFIX = BeamlinePrefix(BL)
 
 
-LOOK_UPTABLE_DIR = "/dls_sw/i10/software/gda/workspace_git/gda-diamond.git/configurations/i10-shared/lookupTables/"
-"""
-I10 has two insertion devices one up(idu) and one down stream(idd).
-It is worth noting that the down stream device is slightly longer,
- so it can reach Mn edge for linear arbitrary.
- idd == id1
- and
- idu == id2.
-"""
-
-
-def idd_gap(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorGap:
-    return device_instantiation(
-        device_factory=UndulatorGap,
-        name="idd_gap",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
-
-
-def idd_phase_axes(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorPhaseAxes:
-    return device_instantiation(
-        device_factory=UndulatorPhaseAxes,
-        name="idd_phase_axes",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        top_outer="RPQ1",
-        top_inner="RPQ2",
-        btm_inner="RPQ3",
-        btm_outer="RPQ4",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
-
-
-def idd_jaw(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorJawPhase:
-    return device_instantiation(
-        device_factory=UndulatorJawPhase,
-        name="idd_jaw",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
-        move_pv="RPQ1",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
-
-
-def idu_gap(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorGap:
-    return device_instantiation(
-        device_factory=UndulatorGap,
-        name="idu_gap",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
-
-
-def idu_phase_axes(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorPhaseAxes:
-    return device_instantiation(
-        device_factory=UndulatorPhaseAxes,
-        name="idu_phase_axes",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
-        top_outer="RPQ1",
-        top_inner="RPQ2",
-        btm_inner="RPQ3",
-        btm_outer="RPQ4",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
-
-
-def idu_jaw(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> UndulatorJawPhase:
-    return device_instantiation(
-        device_factory=UndulatorJawPhase,
-        name="idu_jaw",
-        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
-        move_pv="RPQ1",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-        bl_prefix=False,
-    )
+LOOK_UPTABLE_DIR = "/dls_sw/i10/software/blueapi/scratch/i10-config/lookupTables/"
 
 
-def pgm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) -> PGM:
-    return device_instantiation(
-        device_factory=PGM,
-        name="pgm",
-        prefix="-OP-PGM-01:",
+@device_factory()
+def pgm() -> PGM:
+    "I10 Plane Grating Monochromator, it can change energy via pgm.energy.set(<energy>)"
+    return PGM(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=I10Grating,
         gratingPv="NLINES2",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idu_gap_phase(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2:
-    return device_instantiation(
-        device_factory=I10Apple2,
-        id_gap=idu_gap(wait_for_connection, fake_with_ophyd_sim),
-        id_phase=idu_phase_axes(wait_for_connection, fake_with_ophyd_sim),
-        id_jaw_phase=idu_jaw(wait_for_connection, fake_with_ophyd_sim),
-        energy_gap_table_path=Path(
-            LOOK_UPTABLE_DIR + "IDEnergy2GapCalibrations.csv",
-        ),
-        energy_phase_table_path=Path(
-            LOOK_UPTABLE_DIR + "IDEnergy2PhaseCalibrations.csv",
-        ),
-        source=("Source", "idu"),
-        name="idu_gap_phase",
-        prefix="",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
     )
 
 
-def idd_gap_phase(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2:
-    return device_instantiation(
-        device_factory=I10Apple2,
-        id_gap=idd_gap(wait_for_connection, fake_with_ophyd_sim),
-        id_phase=idd_phase_axes(wait_for_connection, fake_with_ophyd_sim),
-        id_jaw_phase=idd_jaw(wait_for_connection, fake_with_ophyd_sim),
-        energy_gap_table_path=Path(
-            LOOK_UPTABLE_DIR + "IDEnergy2GapCalibrations.csv",
-        ),
-        energy_phase_table_path=Path(
-            LOOK_UPTABLE_DIR + "IDEnergy2PhaseCalibrations.csv",
-        ),
+@device_factory()
+def idd() -> I10Id:
+    """i10 downstream insertion device:
+    id.energy.set(<energy>) to change beamline energy.
+    id.energy.energy_offset.set(<off_set>) to change id energy offset relative to pgm.
+    id.pol.set(<polarisation>) to change polarisation.
+    id.laa.set(<linear polarisation angle>) to change polarisation angle, must be in LA mode.
+    """
+    return I10Id(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-01:",
+        pgm=pgm(),
+        look_up_table_dir=LOOK_UPTABLE_DIR,
         source=("Source", "idd"),
-        name="idd_gap_phase",
-        prefix="",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
     )
 
 
-def idu_pol(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2Pol:
-    return device_instantiation(
-        device_factory=I10Apple2Pol,
-        prefix="",
-        id=idu_gap_phase(wait_for_connection, fake_with_ophyd_sim),
-        name="idu_pol",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idd_pol(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2Pol:
-    return device_instantiation(
-        device_factory=I10Apple2Pol,
-        prefix="",
-        id=idd_gap_phase(wait_for_connection, fake_with_ophyd_sim),
-        name="idd_pol",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idu(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2PGM:
-    return device_instantiation(
-        device_factory=I10Apple2PGM,
-        prefix="",
-        id=idu_gap_phase(wait_for_connection, fake_with_ophyd_sim),
-        pgm=pgm(wait_for_connection, fake_with_ophyd_sim),
-        name="idu",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idd(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> I10Apple2PGM:
-    return device_instantiation(
-        device_factory=I10Apple2PGM,
-        prefix="",
-        id=idd_gap_phase(wait_for_connection, fake_with_ophyd_sim),
-        pgm=pgm(wait_for_connection, fake_with_ophyd_sim),
-        name="idd",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idu_la_angle(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> LinearArbitraryAngle:
-    return device_instantiation(
-        device_factory=LinearArbitraryAngle,
-        prefix="",
-        id=idu(wait_for_connection, fake_with_ophyd_sim),
-        name="idu_la_angle",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
-    )
-
-
-def idd_la_angle(
-    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> LinearArbitraryAngle:
-    return device_instantiation(
-        device_factory=LinearArbitraryAngle,
-        prefix="",
-        id=idu(wait_for_connection, fake_with_ophyd_sim),
-        name="idd_la_angle",
-        wait=wait_for_connection,
-        fake=fake_with_ophyd_sim,
+@device_factory()
+def idu() -> I10Id:
+    """i10 upstream insertion device:
+    id.energy.set(<energy>) to change beamline energy.
+    id.energy.energy_offset.set(<off_set>) to change id energy offset relative to pgm.
+    id.pol.set(<polarisation>) to change polarisation.
+    id.laa.set(<linear polarisation angle>) to change polarisation angle, must be in LA mode.
+    """
+    return I10Id(
+        prefix=f"{PREFIX.insertion_prefix}-MO-SERVC-21:",
+        pgm=pgm(),
+        look_up_table_dir=LOOK_UPTABLE_DIR,
+        source=("Source", "idu"),
     )
 
 
@@ -342,7 +150,7 @@ def pa_stage() -> PaStage:
 
 
 @device_factory()
-def simple_stage() -> XYZPositioner:
+def sample_stage() -> XYZPositioner:
     return XYZPositioner(prefix="ME01D-MO-CRYO-01:")
 
 

dodal/beamlines/i18.py

@@ -113,7 +113,7 @@ def hfm() -> KBMirror:
 
 
 @device_factory()
-def d7diode() -> Diode:
+def d7_diode() -> Diode:
     return Diode(f"{PREFIX.beamline_prefix}-DI-PHDGN-07:")
 
 

dodal/beamlines/i19_1.py

@@ -6,9 +6,12 @@ from dodal.common.beamlines.beamline_utils import (
 )
 from dodal.devices.i19.beamstop import BeamStop
 from dodal.devices.i19.blueapi_device import HutchState
-from dodal.devices.i19.shutter import AccessControlledShutter
-from dodal.devices.oav.oav_detector import OAV
-from dodal.devices.oav.oav_parameters import OAVConfig
+from dodal.devices.i19.shutter import (
+    AccessControlledShutter,
+    HutchState,
+)
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
@@ -48,10 +51,10 @@ def beamstop() -> BeamStop:
 
 
 @device_factory()
-def oav() -> OAV:
-    return OAV(
+def oav() -> OAVBeamCentreFile:
+    return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-EA-OAV-01:",
-        config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
     )
 
 

dodal/beamlines/i24.py

@@ -15,8 +15,8 @@ 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
-from dodal.devices.oav.oav_parameters import OAVConfig
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.oav.oav_parameters import OAVConfigBeamCentre
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
     ZebraMapping,
@@ -150,11 +150,11 @@ def pmac() -> PMAC:
 
 
 @device_factory(skip=BL == "s24")
-def oav() -> OAV:
-    return OAV(
+def oav() -> OAVBeamCentreFile:
+    return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
         name="oav",
-        config=OAVConfig(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
     )
 
 

dodal/beamlines/k11.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+from ophyd_async.epics.motor import Motor
+
+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.log import set_beamline as set_log_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name
+
+beamline = get_beamline_name("k11")
+PREFIX = BeamlinePrefix(beamline)
+set_log_beamline(beamline)
+set_utils_beamline(beamline)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        beamline,
+        Path("/dls/k11/data/2025/cm40627-3"),
+        client=RemoteDirectoryServiceClient("https://k11-control:8088/api"),
+    )
+)
+
+
+@device_factory()
+def kb_x() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:X")
+
+
+@device_factory()
+def kb_y() -> Motor:
+    return Motor(f"{PREFIX.beamline_prefix}-OP-KBM-01:CS:Y")

dodal/common/beamlines/beamline_parameters.py

@@ -1,3 +1,4 @@
+import ast
 from typing import Any, cast
 
 from dodal.log import LOGGER
@@ -57,34 +58,7 @@ class GDABeamlineParameters:
 
     @classmethod
     def parse_value(cls, value: str):
-        if value[0] == "[":
-            return cls.parse_list(value[1:].strip())
-        else:
-            return cls.parse_list_element(value)
-
-    @classmethod
-    def parse_list_element(cls, value: str):
-        if value == "Yes":
-            return True
-        elif value == "No":
-            return False
-        else:
-            return float(value)
-
-    @classmethod
-    def parse_list(cls, value: str):
-        list_output = []
-        remaining = value.strip()
-        i = 0
-        while (i := remaining.find(",")) != -1:
-            list_output.append(cls.parse_list_element(remaining[:i]))
-            remaining = remaining[i + 1 :].lstrip()
-        if (i := remaining.find("]")) != -1:
-            list_output.append(cls.parse_list_element(remaining[:i]))
-            remaining = remaining[i + 1 :].lstrip()
-        else:
-            raise ValueError("Missing closing ']' in list expression")
-        return list_output
+        return ast.literal_eval(value.replace("Yes", "True").replace("No", "False"))
 
 
 def get_beamline_parameters(beamline_param_path: str | None = None):

dodal/common/beamlines/device_helpers.py

@@ -3,6 +3,7 @@ from dodal.devices.slits import Slits
 from dodal.utils import skip_device
 
 HDF5_SUFFIX = "HDF5:"
+TIFF_SUFFIX = "TIFF:"
 CAM_SUFFIX = "CAM:"
 DET_SUFFIX = "DET:"
 

dodal/devices/aithre_lasershaping/goniometer.py

@@ -1,9 +1,21 @@
-from ophyd_async.core import StandardReadable
+import asyncio
+import math
+
+from ophyd_async.core import StandardReadable, derived_signal_rw
 from ophyd_async.epics.motor import Motor
 
 
 class Goniometer(StandardReadable):
-    """Goniometer and the stages it sits on"""
+    """The Aithre lab goniometer and the XYZ stage it sits on.
+
+    `x`, `y` and `z` control the axes of the positioner at the base, while `sampy` and
+    `sampz` control the positioner of the sample. `omega` is the rotation about the
+    x-axis (along the length of the sample holder).
+
+    The `vertical_position` signal refers to the height of the sample from the point of
+    view of the OAV and setting this value moves the sample vertically in the OAV plane
+    regardless of the current rotation.
+    """
 
     def __init__(self, prefix: str, name: str = "") -> None:
         self.x = Motor(prefix + "X")
@@ -12,4 +24,26 @@ class Goniometer(StandardReadable):
         self.sampy = Motor(prefix + "SAMPY")
         self.sampz = Motor(prefix + "SAMPZ")
         self.omega = Motor(prefix + "OMEGA")
+        self.vertical_position = derived_signal_rw(
+            self._get,
+            self._set,
+            sampy=self.sampy,
+            sampz=self.sampz,
+            omega=self.omega,
+        )
         super().__init__(name)
+
+    def _get(self, sampz: float, sampy: float, omega: float) -> float:
+        z_component = sampz * math.cos(math.radians(omega))
+        y_component = sampy * math.sin(math.radians(omega))
+        return z_component + y_component
+
+    async def _set(self, value: float) -> None:
+        omega = await self.omega.user_readback.get_value()
+        z_component = value * math.cos(math.radians(omega))
+        y_component = value * math.sin(math.radians(omega))
+        await asyncio.gather(
+            self.sampy.set(y_component),
+            self.sampz.set(z_component),
+            self.omega.set(omega),
+        )

dodal/devices/aithre_lasershaping/laser_robot.py

@@ -0,0 +1,27 @@
+from ophyd_async.core import StrictEnum
+from ophyd_async.epics.core import epics_signal_rw
+
+from dodal.devices.robot import BartRobot
+
+
+class ForceBit(StrictEnum):
+    ON = "On"
+    NO = "No"
+    OFF = "Off"
+
+
+class LidHeatEnable(StrictEnum):
+    ENABLED = "Enabled"
+    DISABLED = "Disabled"
+
+
+class LaserRobot(BartRobot):
+    def __init__(self, name: str, prefix: str) -> None:
+        self.dewar_lid_heater = epics_signal_rw(
+            LidHeatEnable, prefix + "DW_1_ENABLED", prefix + "DW_1_CTRL"
+        )
+        self.cryojet_retract = epics_signal_rw(ForceBit, prefix + "OP_24_FORCE_OPTION")
+        self.set_beamline_safe = epics_signal_rw(
+            ForceBit, prefix + "IP_16_FORCE_OPTION"
+        )
+        super().__init__(name=name, prefix=prefix)