mx-bluesky 1.5.3__py3-none-any.whl → 1.5.5__py3-none-any.whl

mx_bluesky/beamlines/i24/serial/web_gui_plans/general_plans.py

@@ -13,7 +13,6 @@ from dodal.devices.i24.beamstop import Beamstop
 from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import BacklightPositions, DualBacklight
 from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
-from dodal.devices.i24.pilatus_metadata import PilatusMetadata
 from dodal.devices.i24.pmac import PMAC
 from dodal.devices.motors import YZStage
 from dodal.devices.oav.oav_detector import OAVBeamCentreFile
@@ -39,14 +38,13 @@ from mx_bluesky.beamlines.i24.serial.log import (
     _read_visit_directory_from_file,
 )
 from mx_bluesky.beamlines.i24.serial.parameters import (
-    DetectorName,
     FixedTargetParameters,
     get_chip_format,
 )
 from mx_bluesky.beamlines.i24.serial.parameters.utils import EmptyMapError
 from mx_bluesky.beamlines.i24.serial.setup_beamline import pv
 from mx_bluesky.beamlines.i24.serial.setup_beamline.ca import caput
-from mx_bluesky.beamlines.i24.serial.setup_beamline.pv_abstract import Eiger, Pilatus
+from mx_bluesky.beamlines.i24.serial.setup_beamline.pv_abstract import Eiger
 from mx_bluesky.beamlines.i24.serial.setup_beamline.setup_detector import (
     _move_detector_stage,
     get_detector_type,
@@ -103,10 +101,10 @@ def gui_sleep(sec: int) -> MsgGenerator:
 
 @bpp.run_decorator()
 def gui_move_detector(
-    det: Literal["eiger", "pilatus"],
+    det: Literal["eiger"],
     detector_stage: YZStage = inject("detector_motion"),
 ) -> MsgGenerator:
-    det_y_target = Eiger.det_y_target if det == "eiger" else Pilatus.det_y_target
+    det_y_target = Eiger.det_y_target
     yield from _move_detector_stage(detector_stage, det_y_target)
     # Make the output readable
     SSX_LOGGER.debug(f"Detector move done, resetting general PV to {det}")
@@ -138,9 +136,7 @@ def gui_run_chip_collection(
     shutter: HutchShutter = inject("shutter"),
     dcm: DCM = inject("dcm"),
     mirrors: FocusMirrorsMode = inject("focus_mirrors"),
-    beam_center_pilatus: DetectorBeamCenter = inject("pilatus_bc"),
     beam_center_eiger: DetectorBeamCenter = inject("eiger_bc"),
-    pilatus_metadata: PilatusMetadata = inject("pilatus_meta"),
 ) -> MsgGenerator:
     """Set the parameter model for the data collection.
 
@@ -210,11 +206,7 @@ def gui_run_chip_collection(
     if parameters.chip_map:
         yield from upload_chip_map_to_geobrick(pmac, parameters.chip_map)
 
-    beam_center_device = (
-        beam_center_eiger
-        if parameters.detector_name is DetectorName.EIGER
-        else beam_center_pilatus
-    )
+    beam_center_device = beam_center_eiger
     SSX_LOGGER.info("Beam center device ready")
 
     # DCID instance - do not create yet
@@ -234,5 +226,4 @@ def gui_run_chip_collection(
         beam_center_device,
         parameters,
         dcid,
-        pilatus_metadata,
     )

mx_bluesky/beamlines/i24/serial/write_nexus.py

@@ -35,8 +35,9 @@ def call_nexgen(
         start_time (datetime): Collection start time.
 
     Raises:
-        ValueError: For a wrong experiment type passed (either unknwon or not matched \
+        ValueError: For a wrong experiment type passed (either unknown or not matched \
             to parameter model).
+        HTTPError: For a problem with reponse from server
 
     """
     current_chip_map = None
@@ -75,10 +76,6 @@ def call_nexgen(
         f"Call to nexgen server with the following chip definition: \n{chip_prog_dict}"
     )
 
-    access_token = pathlib.Path("/scratch/ssx_nexgen.key").read_text().strip()
-    url = "https://ssx-nexgen.diamond.ac.uk/ssx_eiger/write"
-    headers = {"Authorization": f"Bearer {access_token}"}
-
     payload = {
         "beamline": "i24",
         "beam_center": beam_center_in_pix,
@@ -98,8 +95,36 @@ def call_nexgen(
         "bit_depth": bit_depth,
         "start_time": start_time.isoformat(),
     }
-    SSX_LOGGER.info(f"Sending POST request to {url} with payload:")
-    SSX_LOGGER.info(pprint.pformat(payload))
-    response = requests.post(url, headers=headers, json=payload)
-    response.raise_for_status()
+    submit_to_server(payload)
+
+
+def submit_to_server(
+    payload: dict | None,
+):
+    """Submit the payload to nexgen-server.
+
+    Args:
+        payload (dict): Dictionary of parameters to send to nex-gen server
+
+    Raises:
+        ValueError: For a wrong experiment type passed (either unknown or not matched \
+            to parameter model).
+        HTTPError: For a problem with reponse from server
+
+    """
+    access_token = pathlib.Path("/scratch/ssx_nexgen.key").read_text().strip()
+    url = "https://ssx-nexgen.diamond.ac.uk/ssx_eiger/write"
+    headers = {"Authorization": f"Bearer {access_token}"}
+
+    try:
+        SSX_LOGGER.info(f"Sending POST request to {url} with payload:")
+        SSX_LOGGER.info(pprint.pformat(payload))
+        response = requests.post(url, headers=headers, json=payload)
+        response.raise_for_status()
+    except requests.HTTPError as e:
+        SSX_LOGGER.error(f"Nexus writer failed. Reason from server {e}")
+        raise
+    except Exception as e:
+        SSX_LOGGER.exception(f"Error generating nexus file: {e}")
+        raise
     SSX_LOGGER.info(f"Response: {response.text} (status code: {response.status_code})")

mx_bluesky/common/device_setup_plans/manipulate_sample.py

@@ -5,7 +5,7 @@ from dodal.devices.aperturescatterguard import (
     ApertureScatterguard,
     ApertureValue,
 )
-from dodal.devices.backlight import Backlight, BacklightPosition
+from dodal.devices.backlight import Backlight, InOut
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.smargon import CombinedMove, Smargon
 
@@ -22,7 +22,7 @@ def setup_sample_environment(
     group="setup_senv",
 ):
     """Move the aperture into required position, move out the backlight."""
-    yield from bps.abs_set(backlight, BacklightPosition.OUT, group=group)
+    yield from bps.abs_set(backlight, InOut.OUT, group=group)
 
     aperture_value = (
         None

mx_bluesky/common/experiment_plans/common_grid_detect_then_xray_centre_plan.py

@@ -7,7 +7,7 @@ from bluesky import plan_stubs as bps
 from bluesky import preprocessors as bpp
 from bluesky.preprocessors import subs_decorator
 from bluesky.utils import MsgGenerator
-from dodal.devices.backlight import BacklightPosition
+from dodal.devices.backlight import InOut
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.oav.oav_parameters import OAVParameters
 
@@ -168,7 +168,7 @@ def detect_grid_and_do_gridscan(
 
     yield from bps.abs_set(
         composite.backlight,
-        BacklightPosition.OUT,
+        InOut.OUT,
         group=PlanGroupCheckpointConstants.GRID_READY_FOR_DC,
     )
 

mx_bluesky/common/experiment_plans/inner_plans/udc_default_state.py

@@ -0,0 +1,65 @@
+import bluesky.plan_stubs as bps
+import pydantic
+from dodal.devices.aperturescatterguard import ApertureScatterguard, ApertureValue
+from dodal.devices.collimation_table import CollimationTable
+from dodal.devices.cryostream import CryoStream
+from dodal.devices.cryostream import InOut as CryoInOut
+from dodal.devices.fluorescence_detector_motion import (
+    FluorescenceDetector,
+)
+from dodal.devices.fluorescence_detector_motion import InOut as FlouInOut
+from dodal.devices.mx_phase1.beamstop import Beamstop, BeamstopPositions
+from dodal.devices.scintillator import InOut as ScinInOut
+from dodal.devices.scintillator import Scintillator
+
+
+@pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
+class UDCDefaultDevices:
+    cryostream: CryoStream
+    fluorescence_det_motion: FluorescenceDetector
+    beamstop: Beamstop
+    scintillator: Scintillator
+    aperture_scatterguard: ApertureScatterguard
+    collimation_table: CollimationTable
+
+
+def move_to_udc_default_state(devices: UDCDefaultDevices):
+    """Moves beamline to known positions prior to UDC start"""
+
+    cryostream_temp = yield from bps.rd(devices.cryostream.temperature_k)
+    cryostream_pressure = yield from bps.rd(devices.cryostream.back_pressure_bar)
+    if cryostream_temp > devices.cryostream.MAX_TEMP_K:
+        raise ValueError("Cryostream temperature is too high, not starting UDC")
+    if cryostream_pressure > devices.cryostream.MAX_PRESSURE_BAR:
+        raise ValueError("Cryostream back pressure is too high, not starting UDC")
+
+    yield from bps.abs_set(devices.scintillator.selected_pos, ScinInOut.OUT, wait=True)
+
+    yield from bps.abs_set(
+        devices.fluorescence_det_motion.pos, FlouInOut.OUT, group="udc_default"
+    )
+
+    yield from bps.abs_set(devices.collimation_table.inboard_y, 0, group="udc_default")
+    yield from bps.abs_set(devices.collimation_table.outboard_y, 0, group="udc_default")
+    yield from bps.abs_set(devices.collimation_table.upstream_y, 0, group="udc_default")
+    yield from bps.abs_set(devices.collimation_table.upstream_x, 0, group="udc_default")
+    yield from bps.abs_set(
+        devices.collimation_table.downstream_x, 0, group="udc_default"
+    )
+
+    yield from bps.abs_set(
+        devices.beamstop.selected_pos,
+        BeamstopPositions.DATA_COLLECTION,
+        group="udc_default",
+    )
+
+    yield from bps.abs_set(
+        devices.aperture_scatterguard.selected_aperture,
+        ApertureValue.SMALL,
+        group="udc_default",
+    )
+
+    yield from bps.abs_set(devices.cryostream.course, CryoInOut.IN, group="udc_default")
+    yield from bps.abs_set(devices.cryostream.fine, CryoInOut.IN, group="udc_default")
+
+    yield from bps.wait("udc_default")

mx_bluesky/common/experiment_plans/oav_snapshot_plan.py

@@ -4,7 +4,7 @@ from typing import Protocol
 from bluesky import plan_stubs as bps
 from bluesky.utils import MsgGenerator
 from dodal.devices.aperturescatterguard import ApertureScatterguard, ApertureValue
-from dodal.devices.backlight import Backlight, BacklightPosition
+from dodal.devices.backlight import Backlight, InOut
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAVParameters
 from dodal.devices.smargon import Smargon
@@ -36,7 +36,7 @@ def setup_beamline_for_OAV(
 ):
     max_vel = yield from bps.rd(smargon.omega.max_velocity)
     yield from bps.abs_set(smargon.omega.velocity, max_vel, group=group)
-    yield from bps.abs_set(backlight, BacklightPosition.IN, group=group)
+    yield from bps.abs_set(backlight, InOut.IN, group=group)
     yield from bps.abs_set(
         aperture_scatterguard.selected_aperture, ApertureValue.OUT_OF_BEAM, group=group
     )

mx_bluesky/common/external_interaction/callbacks/common/grid_detection_callback.py

@@ -1,4 +1,4 @@
-from typing import TypedDict
+from typing import Generic, TypedDict, TypeVar
 
 import numpy as np
 from bluesky.callbacks import CallbackBase
@@ -7,6 +7,8 @@ from event_model.documents import Event
 
 from mx_bluesky.common.utils.log import LOGGER
 
+T = TypeVar("T", int, float)
+
 
 class GridParamUpdate(TypedDict):
     """
@@ -40,14 +42,22 @@ class GridParamUpdate(TypedDict):
     z_step_size_um: float
 
 
+class XYZParams(TypedDict, Generic[T]):
+    x: T
+    y: T
+    z: T
+
+
 class GridDetectionCallback(CallbackBase):
+    OMEGA_TOLERANCE = 1
+
     def __init__(
         self,
         *args,
     ) -> None:
         super().__init__(*args)
-        self.start_positions_mm: list = []
-        self.box_numbers: list = []
+        self.start_positions_um: XYZParams[float] = XYZParams(x=0, y=0, z=0)
+        self.box_numbers: XYZParams[int] = XYZParams(x=0, y=0, z=0)
 
     def event(self, doc: Event):
         data = doc.get("data")
@@ -82,13 +92,21 @@ class GridDetectionCallback(CallbackBase):
         )
         LOGGER.info(f"Calculated start position {position_grid_start_mm}")
 
-        self.start_positions_mm.append(position_grid_start_mm)
-        self.box_numbers.append(
-            (
-                data["oav-grid_snapshot-num_boxes_x"],
-                data["oav-grid_snapshot-num_boxes_y"],
+        # If data is taken at omega=~0 then it gives us x-y info, at omega=~-90 it is x-z
+        if abs(smargon_omega) < self.OMEGA_TOLERANCE:
+            self.start_positions_um["x"] = position_grid_start_mm[0] * 1000
+            self.start_positions_um["y"] = position_grid_start_mm[1] * 1000
+            self.box_numbers["x"] = data["oav-grid_snapshot-num_boxes_x"]
+            self.box_numbers["y"] = data["oav-grid_snapshot-num_boxes_y"]
+        elif abs(smargon_omega + 90) < self.OMEGA_TOLERANCE:
+            self.start_positions_um["x"] = position_grid_start_mm[0] * 1000
+            self.start_positions_um["z"] = position_grid_start_mm[2] * 1000
+            self.box_numbers["x"] = data["oav-grid_snapshot-num_boxes_x"]
+            self.box_numbers["z"] = data["oav-grid_snapshot-num_boxes_y"]
+        else:
+            raise ValueError(
+                f"Grid detection only works at omegas of 0 or -90, omega of {smargon_omega} given."
             )
-        )
 
         self.x_step_size_um = box_width_px * microns_per_pixel_x
         self.y_step_size_um = box_width_px * microns_per_pixel_y
@@ -97,14 +115,14 @@ class GridDetectionCallback(CallbackBase):
 
     def get_grid_parameters(self) -> GridParamUpdate:
         return {
-            "x_start_um": self.start_positions_mm[0][0] * 1000,
-            "y_start_um": self.start_positions_mm[0][1] * 1000,
-            "y2_start_um": self.start_positions_mm[0][1] * 1000,
-            "z_start_um": self.start_positions_mm[1][2] * 1000,
-            "z2_start_um": self.start_positions_mm[1][2] * 1000,
-            "x_steps": self.box_numbers[0][0],
-            "y_steps": self.box_numbers[0][1],
-            "z_steps": self.box_numbers[1][1],
+            "x_start_um": self.start_positions_um["x"],
+            "y_start_um": self.start_positions_um["y"],
+            "y2_start_um": self.start_positions_um["y"],
+            "z_start_um": self.start_positions_um["z"],
+            "z2_start_um": self.start_positions_um["z"],
+            "x_steps": self.box_numbers["x"],
+            "y_steps": self.box_numbers["y"],
+            "z_steps": self.box_numbers["z"],
             "x_step_size_um": self.x_step_size_um,
             "y_step_size_um": self.y_step_size_um,
             "z_step_size_um": self.z_step_size_um,

mx_bluesky/common/external_interaction/callbacks/common/ispyb_callback_base.py

@@ -186,7 +186,7 @@ class BaseISPyBCallback(PlanReactiveCallback):
         pass
 
     def activity_gated_stop(self, doc: RunStop) -> RunStop:
-        """Subclasses must check that they are recieving a stop document for the correct
+        """Subclasses must check that they are receiving a stop document for the correct
         uid to use this method!"""
         assert self.ispyb is not None, (
             "ISPyB handler received stop document, but deposition object doesn't exist!"

mx_bluesky/common/external_interaction/callbacks/common/plan_reactive_callback.py

@@ -24,8 +24,8 @@ class PlanReactiveCallback(CallbackBase):
         metadata to trigger this.
         The run_decorator of the plan should include in its metadata dictionary the key
         'activate callbacks', with a list of strings of the callback class(es) to
-        activate or deactivate. On a recieving a start doc which specifies this, this
-        class will be activated, and on recieving the stop document for the
+        activate or deactivate. On a receiving a start doc which specifies this, this
+        class will be activated, and on receiving the stop document for the
         corresponding uid it will deactivate. The ordinary 'start', 'descriptor',
         'event' and 'stop' methods will be triggered as normal, and will in turn trigger
         'activity_gated_' methods - to preserve this functionality, subclasses which

mx_bluesky/common/external_interaction/callbacks/sample_handling/sample_handling_callback.py

@@ -17,8 +17,9 @@ from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER
 
 
 class SampleHandlingCallback(PlanReactiveCallback):
-    """Intercepts exceptions from experiment plans and updates the ISPyB BLSampleStatus
-    field according to the type of exception raised."""
+    """Intercepts exceptions from experiment plans and:
+    * Updates the ISPyB BLSampleStatus field according to the type of exception raised.
+    * Triggers an alert with details of the error."""
 
     def __init__(self, record_loaded_on_success=False):
         super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)

mx_bluesky/common/external_interaction/callbacks/xray_centre/ispyb_callback.py

@@ -69,8 +69,8 @@ ispyb_activation_decorator = make_decorator(ispyb_activation_wrapper)
 class GridscanISPyBCallback(BaseISPyBCallback):
     """Callback class to handle the deposition of experiment parameters into the ISPyB
     database. Listens for 'event' and 'descriptor' documents. Creates the ISpyB entry on
-    recieving an 'event' document for the 'ispyb_reading_hardware' event, and updates the
-    deposition on recieving its final 'stop' document.
+    receiving an 'event' document for the 'ispyb_reading_hardware' event, and updates the
+    deposition on receiving its final 'stop' document.
 
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.:

mx_bluesky/common/external_interaction/callbacks/xray_centre/nexus_callback.py

@@ -24,10 +24,10 @@ T = TypeVar("T", bound="SpecifiedThreeDGridScan")
 
 class GridscanNexusFileCallback(PlanReactiveCallback):
     """Callback class to handle the creation of Nexus files based on experiment \
-    parameters. Initialises on recieving a 'start' document for the \
+    parameters. Initialises on receiving a 'start' document for the \
     'run_gridscan_move_and_tidy' sub plan, which must also contain the run parameters, \
     as metadata under the 'hyperion_internal_parameters' key. Actually writes the \
-    nexus files on updates the timestamps on recieving the 'ispyb_reading_hardware' event \
+    nexus files on updates the timestamps on receiving the 'ispyb_reading_hardware' event \
     document, and finalises the files on getting a 'stop' document for the whole run.
 
     To use, subscribe the Bluesky RunEngine to an instance of this class.

mx_bluesky/common/parameters/constants.py

@@ -23,6 +23,7 @@ GDA_DOMAIN_PROPERTIES_PATH = (
 @dataclass(frozen=True)
 class DocDescriptorNames:
     # Robot load/unload event descriptor
+    ROBOT_PRE_LOAD = "robot_update_pre_load"
     ROBOT_UPDATE = "robot_update"
     # For callbacks to use
     OAV_ROTATION_SNAPSHOT_TRIGGERED = "rotation_snapshot_triggered"

mx_bluesky/hyperion/baton_handler.py

@@ -8,8 +8,17 @@ from bluesky import preprocessors as bpp
 from bluesky.utils import MsgGenerator, RunEngineInterrupted
 from dodal.devices.baton import Baton
 
+from mx_bluesky.common.experiment_plans.inner_plans.udc_default_state import (
+    UDCDefaultDevices,
+    move_to_udc_default_state,
+)
+from mx_bluesky.common.external_interaction.alerting import (
+    AlertService,
+    get_alerting_service,
+)
 from mx_bluesky.common.parameters.components import MxBlueskyParameters
 from mx_bluesky.common.utils.context import (
+    device_composite_from_context,
     find_device_in_context,
 )
 from mx_bluesky.common.utils.log import LOGGER
@@ -20,6 +29,7 @@ from mx_bluesky.hyperion.experiment_plans.load_centre_collect_full_plan import (
 from mx_bluesky.hyperion.external_interaction.agamemnon import (
     create_parameters_from_agamemnon,
 )
+from mx_bluesky.hyperion.external_interaction.alerting.constants import Subjects
 from mx_bluesky.hyperion.parameters.components import Wait
 from mx_bluesky.hyperion.parameters.load_centre_collect import LoadCentreCollect
 from mx_bluesky.hyperion.plan_runner import PlanException, PlanRunner
@@ -81,7 +91,8 @@ def run_udc_when_requested(context: BlueskyContext, runner: PlanRunner):
             baton: The baton device
             runner: The runner
         """
-        yield from _move_to_default_state()
+        _raise_udc_start_alert(get_alerting_service())
+        yield from _move_to_udc_default_state(context)
 
         # re-fetch the baton because the device has been reinstantiated
         baton = _get_baton(context)
@@ -92,8 +103,9 @@ def run_udc_when_requested(context: BlueskyContext, runner: PlanRunner):
         # If hyperion has given up the baton itself we need to also release requested
         # user so that hyperion doesn't think we're requested again
         baton = _get_baton(context)
-        yield from _safely_release_baton(baton)
-        yield from bps.abs_set(baton.current_user, NO_USER)
+        previous_requested_user = yield from _safely_release_baton(baton)
+        yield from bps.abs_set(baton.current_user, NO_USER, wait=True)
+        _raise_baton_released_alert(get_alerting_service(), previous_requested_user)
 
     def collect_then_release() -> MsgGenerator:
         yield from bpp.contingency_wrapper(collect(), final_plan=release_baton)
@@ -147,10 +159,34 @@ def _fetch_and_process_agamemnon_instruction(
                         f"Unsupported instruction decoded from agamemnon {type(parameters)}"
                     )
     else:
+        _raise_udc_completed_alert(get_alerting_service())
         # Release the baton for orderly exit from the instruction loop
         yield from _safely_release_baton(baton)
 
 
+def _raise_udc_start_alert(alert_service: AlertService):
+    alert_service.raise_alert(
+        Subjects.UDC_STARTED, "Unattended Data Collection has started.", {}
+    )
+
+
+def _raise_baton_released_alert(alert_service: AlertService, baton_requester: str):
+    alert_service.raise_alert(
+        Subjects.UDC_BATON_RELEASED,
+        f"Hyperion has released the baton. The baton is currently requested by:"
+        f" {baton_requester}",
+        {},
+    )
+
+
+def _raise_udc_completed_alert(alert_service: AlertService):
+    alert_service.raise_alert(
+        Subjects.UDC_COMPLETED,
+        "Hyperion UDC has completed all pending Agamemnon requests.",
+        {},
+    )
+
+
 def _runner_sleep(parameters: Wait) -> MsgGenerator:
     yield from bps.sleep(parameters.duration_s)
 
@@ -160,18 +196,24 @@ def _is_requesting_baton(baton: Baton) -> MsgGenerator:
     return requested_user == HYPERION_USER
 
 
-def _move_to_default_state() -> MsgGenerator:
-    # To be filled in in https://github.com/DiamondLightSource/mx-bluesky/issues/396
-    yield from bps.null()
+def _move_to_udc_default_state(context: BlueskyContext):
+    udc_default_devices = device_composite_from_context(context, UDCDefaultDevices)
+    yield from move_to_udc_default_state(udc_default_devices)
 
 
 def _get_baton(context: BlueskyContext) -> Baton:
     return find_device_in_context(context, "baton", Baton)
 
 
-def _safely_release_baton(baton: Baton) -> MsgGenerator:
+def _safely_release_baton(baton: Baton) -> MsgGenerator[str]:
     """Relinquish the requested user of the baton if it is not already requested
-    by another user."""
+    by another user.
+
+    Returns:
+        The previously requested user, or NO_USER if no user was already requested.
+    """
     requested_user = yield from bps.rd(baton.requested_user)
     if requested_user == HYPERION_USER:
         yield from bps.abs_set(baton.requested_user, NO_USER)
+        return NO_USER
+    return requested_user

mx_bluesky/hyperion/experiment_plans/load_centre_collect_full_plan.py

@@ -69,7 +69,11 @@ def load_centre_collect_full(
                 "visit": parameters.visit,
                 "container": parameters.sample_puck,
             },
-            "activate_callbacks": ["BeamDrawingCallback", "SampleHandlingCallback"],
+            "activate_callbacks": [
+                "BeamDrawingCallback",
+                "SampleHandlingCallback",
+                "AlertOnContainerChange",
+            ],
             "with_snapshot": parameters.multi_rotation_scan.model_dump_json(
                 include=WithSnapshot.model_fields.keys()  # type: ignore
             ),

mx_bluesky/hyperion/experiment_plans/robot_load_and_change_energy.py

@@ -12,7 +12,7 @@ from blueapi.core import BlueskyContext
 from bluesky.utils import Msg
 from dodal.devices.aperturescatterguard import ApertureScatterguard
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
-from dodal.devices.backlight import Backlight, BacklightPosition
+from dodal.devices.backlight import Backlight, InOut
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
 from dodal.devices.i03.dcm import DCM
 from dodal.devices.i03.undulator_dcm import UndulatorDCM
@@ -123,7 +123,11 @@ def robot_load_and_snapshots(
     thawing_time: float,
     demand_energy_ev: float | None,
 ):
-    yield from bps.abs_set(composite.backlight, BacklightPosition.IN, group="snapshot")
+    yield from bps.abs_set(composite.backlight, InOut.IN, group="snapshot")
+
+    yield from bps.create(name=CONST.DESCRIPTORS.ROBOT_PRE_LOAD)
+    yield from bps.read(composite.robot)
+    yield from bps.save()
 
     robot_load_plan = do_robot_load(
         composite,

mx_bluesky/hyperion/external_interaction/alerting/constants.py

@@ -3,10 +3,5 @@ from enum import StrEnum
 
 class Subjects(StrEnum):
     UDC_STARTED = "UDC Started"
-    UDC_BATON_PASSED = "UDC Baton was passed"
-    UDC_RESUMED_OPERATION = "UDC Resumed operation"
-    UDC_SUSPENDED_OPERATION = "UDC Suspended operation"
-    NEW_CONTAINER = "Hyperion is collecting from a new container"
-    NEW_VISIT = "Hyperion has changed visit"
-    SAMPLE_ERROR = "Hyperion has encountered a sample error"
-    BEAMLINE_ERROR = "Hyperion has encountered a beamline error"
+    UDC_BATON_RELEASED = "UDC Baton was released"
+    UDC_COMPLETED = "UDC Completed"

mx_bluesky/hyperion/external_interaction/callbacks/__main__.py

@@ -33,6 +33,9 @@ from mx_bluesky.common.utils.log import (
     _get_logging_dirs,
     tag_filter,
 )
+from mx_bluesky.hyperion.external_interaction.callbacks.alert_on_container_change import (
+    AlertOnContainerChange,
+)
 from mx_bluesky.hyperion.external_interaction.callbacks.robot_actions.ispyb_callback import (
     RobotLoadISPyBCallback,
 )
@@ -89,6 +92,7 @@ def setup_callbacks() -> list[CallbackBase]:
         LogUidTaggingCallback(),
         RobotLoadISPyBCallback(),
         SampleHandlingCallback(),
+        AlertOnContainerChange(),
     ]
 
 

mx_bluesky/hyperion/external_interaction/callbacks/alert_on_container_change.py

@@ -0,0 +1,54 @@
+from dodal.utils import get_beamline_name
+from event_model import Event, EventDescriptor, RunStart
+
+from mx_bluesky.common.external_interaction.alerting import (
+    Metadata,
+    get_alerting_service,
+)
+from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
+    PlanReactiveCallback,
+)
+from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER
+from mx_bluesky.hyperion.parameters.constants import CONST
+
+
+class AlertOnContainerChange(PlanReactiveCallback):
+    """Sends an alert to beamline staff when a pin from a new puck has been loaded.
+    This tends to be used as a heartbeat so we know that UDC is running."""
+
+    def __init__(self):
+        super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)
+        self._new_container = None
+        self._visit = None
+        self._sample_id = None
+        self.descriptors: dict[str, EventDescriptor] = {}
+
+    def activity_gated_descriptor(self, doc: EventDescriptor) -> EventDescriptor | None:
+        self.descriptors[doc["uid"]] = doc
+        return super().activity_gated_descriptor(doc)
+
+    def activity_gated_event(self, doc: Event) -> Event | None:
+        event_descriptor = self.descriptors.get(doc["descriptor"])
+        if (
+            event_descriptor
+            and event_descriptor.get("name") == CONST.DESCRIPTORS.ROBOT_PRE_LOAD
+        ):
+            current_container = int(doc["data"]["robot-current_puck"])
+            if self._new_container != current_container:
+                beamline = get_beamline_name("")
+                get_alerting_service().raise_alert(
+                    f"UDC moved on to puck {self._new_container} on {beamline}",
+                    f"Hyperion finished container {current_container} and moved on to {self._new_container}",
+                    {
+                        Metadata.SAMPLE_ID: str(self._sample_id),
+                        Metadata.VISIT: self._visit or "",
+                        Metadata.CONTAINER: str(self._new_container),
+                    },
+                )
+        return doc
+
+    def activity_gated_start(self, doc: RunStart):
+        metadata = doc.get("metadata", {})
+        self._new_container = metadata.get("container")
+        self._sample_id = metadata.get("sample_id")
+        self._visit = metadata.get("visit")

mx_bluesky/hyperion/external_interaction/callbacks/rotation/ispyb_callback.py

@@ -34,8 +34,8 @@ if TYPE_CHECKING:
 class RotationISPyBCallback(BaseISPyBCallback):
     """Callback class to handle the deposition of experiment parameters into the ISPyB
     database. Listens for 'event' and 'descriptor' documents. Creates the ISpyB entry on
-    recieving an 'event' document for the 'ispyb_reading_hardware' event, and updates the
-    deposition on recieving its final 'stop' document.
+    receiving an 'event' document for the 'ispyb_reading_hardware' event, and updates the
+    deposition on receiving its final 'stop' document.
 
     To use, subscribe the Bluesky RunEngine to an instance of this class.
     E.g.: