mx-bluesky 1.4.1a0__py3-none-any.whl → 1.4.3__py3-none-any.whl

mx_bluesky/hyperion/external_interaction/callbacks/__main__.py

@@ -7,10 +7,24 @@ from bluesky.callbacks.zmq import Proxy, RemoteDispatcher
 from dodal.log import LOGGER as dodal_logger
 from dodal.log import set_up_all_logging_handlers
 
-from mx_bluesky.common.utils.log import _get_logging_dir, tag_filter
-from mx_bluesky.hyperion.external_interaction.callbacks.log_uid_tag_callback import (
+from mx_bluesky.common.external_interaction.callbacks.common.log_uid_tag_callback import (
     LogUidTaggingCallback,
 )
+from mx_bluesky.common.external_interaction.callbacks.common.zocalo_callback import (
+    ZocaloCallback,
+)
+from mx_bluesky.common.external_interaction.callbacks.xray_centre.ispyb_callback import (
+    GridscanISPyBCallback,
+)
+from mx_bluesky.common.external_interaction.callbacks.xray_centre.nexus_callback import (
+    GridscanNexusFileCallback,
+)
+from mx_bluesky.common.utils.log import (
+    ISPYB_ZOCALO_CALLBACK_LOGGER,
+    NEXUS_LOGGER,
+    _get_logging_dir,
+    tag_filter,
+)
 from mx_bluesky.hyperion.external_interaction.callbacks.robot_load.ispyb_callback import (
     RobotLoadISPyBCallback,
 )
@@ -20,21 +34,15 @@ from mx_bluesky.hyperion.external_interaction.callbacks.rotation.ispyb_callback
 from mx_bluesky.hyperion.external_interaction.callbacks.rotation.nexus_callback import (
     RotationNexusFileCallback,
 )
-from mx_bluesky.hyperion.external_interaction.callbacks.xray_centre.ispyb_callback import (
-    GridscanISPyBCallback,
-)
-from mx_bluesky.hyperion.external_interaction.callbacks.xray_centre.nexus_callback import (
-    GridscanNexusFileCallback,
-)
-from mx_bluesky.hyperion.external_interaction.callbacks.zocalo_callback import (
-    ZocaloCallback,
-)
-from mx_bluesky.hyperion.log import (
-    ISPYB_LOGGER,
-    NEXUS_LOGGER,
+from mx_bluesky.hyperion.external_interaction.callbacks.sample_handling.sample_handling_callback import (
+    SampleHandlingCallback,
 )
 from mx_bluesky.hyperion.parameters.cli import parse_callback_dev_mode_arg
 from mx_bluesky.hyperion.parameters.constants import CONST
+from mx_bluesky.hyperion.parameters.gridscan import (
+    GridCommonWithHyperionDetectorParams,
+    HyperionSpecifiedThreeDGridScan,
+)
 
 LIVENESS_POLL_SECONDS = 1
 ERROR_LOG_BUFFER_LINES = 5000
@@ -43,18 +51,21 @@ ERROR_LOG_BUFFER_LINES = 5000
 def setup_callbacks():
     zocalo = ZocaloCallback()
     return [
-        GridscanNexusFileCallback(),
-        GridscanISPyBCallback(emit=zocalo),
+        GridscanNexusFileCallback(param_type=HyperionSpecifiedThreeDGridScan),
+        GridscanISPyBCallback(
+            param_type=GridCommonWithHyperionDetectorParams, emit=zocalo
+        ),
         RotationNexusFileCallback(),
         RotationISPyBCallback(emit=zocalo),
         LogUidTaggingCallback(),
         RobotLoadISPyBCallback(),
+        SampleHandlingCallback(),
     ]
 
 
 def setup_logging(dev_mode: bool):
     for logger, filename in [
-        (ISPYB_LOGGER, "hyperion_ispyb_callback.log"),
+        (ISPYB_ZOCALO_CALLBACK_LOGGER, "hyperion_ispyb_callback.log"),
         (NEXUS_LOGGER, "hyperion_nexus_callback.log"),
     ]:
         if logger.handlers == []:
@@ -70,7 +81,7 @@ def setup_logging(dev_mode: bool):
     log_info(f"Loggers initialised with dev_mode={dev_mode}")
     nexgen_logger = logging.getLogger("nexgen")
     nexgen_logger.parent = NEXUS_LOGGER
-    dodal_logger.parent = ISPYB_LOGGER
+    dodal_logger.parent = ISPYB_ZOCALO_CALLBACK_LOGGER
     log_debug("nexgen logger added to nexus logger")
 
 
@@ -90,12 +101,12 @@ def setup_threads():
 
 
 def log_info(msg, *args, **kwargs):
-    ISPYB_LOGGER.info(msg, *args, **kwargs)
+    ISPYB_ZOCALO_CALLBACK_LOGGER.info(msg, *args, **kwargs)
     NEXUS_LOGGER.info(msg, *args, **kwargs)
 
 
 def log_debug(msg, *args, **kwargs):
-    ISPYB_LOGGER.debug(msg, *args, **kwargs)
+    ISPYB_ZOCALO_CALLBACK_LOGGER.debug(msg, *args, **kwargs)
     NEXUS_LOGGER.debug(msg, *args, **kwargs)
 
 

mx_bluesky/hyperion/external_interaction/callbacks/common/callback_util.py

@@ -2,6 +2,15 @@ from collections.abc import Callable
 
 from bluesky.callbacks import CallbackBase
 
+from mx_bluesky.common.external_interaction.callbacks.common.zocalo_callback import (
+    ZocaloCallback,
+)
+from mx_bluesky.common.external_interaction.callbacks.xray_centre.ispyb_callback import (
+    GridscanISPyBCallback,
+)
+from mx_bluesky.common.external_interaction.callbacks.xray_centre.nexus_callback import (
+    GridscanNexusFileCallback,
+)
 from mx_bluesky.hyperion.external_interaction.callbacks.robot_load.ispyb_callback import (
     RobotLoadISPyBCallback,
 )
@@ -11,54 +20,61 @@ from mx_bluesky.hyperion.external_interaction.callbacks.rotation.ispyb_callback
 from mx_bluesky.hyperion.external_interaction.callbacks.rotation.nexus_callback import (
     RotationNexusFileCallback,
 )
-from mx_bluesky.hyperion.external_interaction.callbacks.xray_centre.ispyb_callback import (
-    GridscanISPyBCallback,
+from mx_bluesky.hyperion.external_interaction.callbacks.sample_handling.sample_handling_callback import (
+    SampleHandlingCallback,
 )
-from mx_bluesky.hyperion.external_interaction.callbacks.xray_centre.nexus_callback import (
-    GridscanNexusFileCallback,
-)
-from mx_bluesky.hyperion.external_interaction.callbacks.zocalo_callback import (
-    ZocaloCallback,
+from mx_bluesky.hyperion.parameters.gridscan import (
+    GridCommonWithHyperionDetectorParams,
+    HyperionSpecifiedThreeDGridScan,
 )
 
 CallbacksFactory = Callable[[], tuple[CallbackBase, ...]]
 
 
-def create_robot_load_and_centre_callbacks() -> (
-    tuple[GridscanNexusFileCallback, GridscanISPyBCallback, RobotLoadISPyBCallback]
-):
+def create_robot_load_and_centre_callbacks() -> tuple[
+    GridscanNexusFileCallback, GridscanISPyBCallback, RobotLoadISPyBCallback
+]:
     return (
-        GridscanNexusFileCallback(),
-        GridscanISPyBCallback(emit=ZocaloCallback()),
+        GridscanNexusFileCallback(param_type=HyperionSpecifiedThreeDGridScan),
+        GridscanISPyBCallback(
+            param_type=GridCommonWithHyperionDetectorParams, emit=ZocaloCallback()
+        ),
         RobotLoadISPyBCallback(),
     )
 
 
-def create_gridscan_callbacks() -> (
-    tuple[GridscanNexusFileCallback, GridscanISPyBCallback]
-):
-    return (GridscanNexusFileCallback(), GridscanISPyBCallback(emit=ZocaloCallback()))
+def create_gridscan_callbacks() -> tuple[
+    GridscanNexusFileCallback, GridscanISPyBCallback
+]:
+    return (
+        GridscanNexusFileCallback(param_type=HyperionSpecifiedThreeDGridScan),
+        GridscanISPyBCallback(
+            param_type=GridCommonWithHyperionDetectorParams, emit=ZocaloCallback()
+        ),
+    )
 
 
-def create_rotation_callbacks() -> (
-    tuple[RotationNexusFileCallback, RotationISPyBCallback]
-):
+def create_rotation_callbacks() -> tuple[
+    RotationNexusFileCallback, RotationISPyBCallback
+]:
     return (RotationNexusFileCallback(), RotationISPyBCallback(emit=ZocaloCallback()))
 
 
-def create_load_centre_collect_callbacks() -> (
-    tuple[
-        GridscanNexusFileCallback,
-        GridscanISPyBCallback,
-        RobotLoadISPyBCallback,
-        RotationNexusFileCallback,
-        RotationISPyBCallback,
-    ]
-):
+def create_load_centre_collect_callbacks() -> tuple[
+    GridscanNexusFileCallback,
+    GridscanISPyBCallback,
+    RobotLoadISPyBCallback,
+    RotationNexusFileCallback,
+    RotationISPyBCallback,
+    SampleHandlingCallback,
+]:
     return (
-        GridscanNexusFileCallback(),
-        GridscanISPyBCallback(emit=ZocaloCallback()),
+        GridscanNexusFileCallback(param_type=HyperionSpecifiedThreeDGridScan),
+        GridscanISPyBCallback(
+            param_type=GridCommonWithHyperionDetectorParams, emit=ZocaloCallback()
+        ),
         RobotLoadISPyBCallback(),
         RotationNexusFileCallback(),
         RotationISPyBCallback(emit=ZocaloCallback()),
+        SampleHandlingCallback(),
     )

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

@@ -2,19 +2,18 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from event_model.documents import EventDescriptor
-
-from mx_bluesky.hyperion.external_interaction.callbacks.common.ispyb_mapping import (
+from mx_bluesky.common.external_interaction.callbacks.common.ispyb_mapping import (
     get_proposal_and_session_from_visit_string,
 )
-from mx_bluesky.hyperion.external_interaction.callbacks.plan_reactive_callback import (
+from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
     PlanReactiveCallback,
 )
-from mx_bluesky.hyperion.external_interaction.ispyb.exp_eye_store import (
+from mx_bluesky.common.external_interaction.ispyb.exp_eye_store import (
+    BLSampleStatus,
     ExpeyeInteraction,
     RobotActionID,
 )
-from mx_bluesky.hyperion.log import ISPYB_LOGGER
+from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER
 from mx_bluesky.hyperion.parameters.constants import CONST
 
 if TYPE_CHECKING:
@@ -23,28 +22,35 @@ if TYPE_CHECKING:
 
 class RobotLoadISPyBCallback(PlanReactiveCallback):
     def __init__(self) -> None:
-        ISPYB_LOGGER.debug("Initialising ISPyB Robot Load Callback")
-        super().__init__(log=ISPYB_LOGGER)
+        ISPYB_ZOCALO_CALLBACK_LOGGER.debug("Initialising ISPyB Robot Load Callback")
+        super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)
+        self._metadata: dict | None = None
+
         self.run_uid: str | None = None
         self.descriptors: dict[str, EventDescriptor] = {}
         self.action_id: RobotActionID | None = None
         self.expeye = ExpeyeInteraction()
 
     def activity_gated_start(self, doc: RunStart):
-        ISPYB_LOGGER.debug("ISPyB robot load callback received start document.")
+        ISPYB_ZOCALO_CALLBACK_LOGGER.debug(
+            "ISPyB robot load callback received start document."
+        )
         if doc.get("subplan_name") == CONST.PLAN.ROBOT_LOAD:
-            ISPYB_LOGGER.debug(f"ISPyB robot load callback received: {doc}")
+            ISPYB_ZOCALO_CALLBACK_LOGGER.debug(
+                f"ISPyB robot load callback received: {doc}"
+            )
             self.run_uid = doc.get("uid")
-            assert isinstance(metadata := doc.get("metadata"), dict)
+            self._metadata = doc.get("metadata")
+            assert isinstance(self._metadata, dict)
             proposal, session = get_proposal_and_session_from_visit_string(
-                metadata["visit"]
+                self._metadata["visit"]
             )
             self.action_id = self.expeye.start_load(
                 proposal,
                 session,
-                metadata["sample_id"],
-                metadata["sample_puck"],
-                metadata["sample_pin"],
+                self._metadata["sample_id"],
+                self._metadata["sample_puck"],
+                self._metadata["sample_pin"],
             )
         return super().activity_gated_start(doc)
 
@@ -58,9 +64,9 @@ class RobotLoadISPyBCallback(PlanReactiveCallback):
             event_descriptor
             and event_descriptor.get("name") == CONST.DESCRIPTORS.ROBOT_LOAD
         ):
-            assert (
-                self.action_id is not None
-            ), "ISPyB Robot load callback event called unexpectedly"
+            assert self.action_id is not None, (
+                "ISPyB Robot load callback event called unexpectedly"
+            )
             barcode = doc["data"]["robot-barcode"]
             oav_snapshot = doc["data"]["oav-snapshot-last_saved_path"]
             webcam_snapshot = doc["data"]["webcam-last_saved_path"]
@@ -72,15 +78,24 @@ class RobotLoadISPyBCallback(PlanReactiveCallback):
         return super().activity_gated_event(doc)
 
     def activity_gated_stop(self, doc: RunStop) -> RunStop | None:
-        ISPYB_LOGGER.debug("ISPyB robot load callback received stop document.")
+        ISPYB_ZOCALO_CALLBACK_LOGGER.debug(
+            "ISPyB robot load callback received stop document."
+        )
         if doc.get("run_start") == self.run_uid:
-            assert (
-                self.action_id is not None
-            ), "ISPyB Robot load callback stop called unexpectedly"
-            exit_status = (
-                doc.get("exit_status") or "Exit status not available in stop document!"
+            assert self.action_id is not None, (
+                "ISPyB Robot load callback stop called unexpectedly"
             )
+            exit_status = doc.get("exit_status")
+            assert exit_status, "Exit status not available in stop document!"
+            assert self._metadata, "Metadata not received before stop document."
             reason = doc.get("reason") or "OK"
+
             self.expeye.end_load(self.action_id, exit_status, reason)
+            self.expeye.update_sample_status(
+                self._metadata["sample_id"],
+                BLSampleStatus.LOADED
+                if exit_status == "success"
+                else BLSampleStatus.ERROR_BEAMLINE,
+            )
             self.action_id = None
         return super().activity_gated_stop(doc)

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

@@ -3,28 +3,27 @@ from __future__ import annotations
 from collections.abc import Callable, Sequence
 from typing import TYPE_CHECKING, Any, cast
 
-from mx_bluesky.common.parameters.components import IspybExperimentType
-from mx_bluesky.common.utils.log import set_dcgid_tag
-from mx_bluesky.hyperion.external_interaction.callbacks.common.ispyb_mapping import (
-    populate_data_collection_group,
-    populate_remaining_data_collection_info,
-)
-from mx_bluesky.hyperion.external_interaction.callbacks.ispyb_callback_base import (
+from mx_bluesky.common.external_interaction.callbacks.common.ispyb_callback_base import (
     BaseISPyBCallback,
 )
-from mx_bluesky.hyperion.external_interaction.callbacks.rotation.ispyb_mapping import (
-    populate_data_collection_info_for_rotation,
+from mx_bluesky.common.external_interaction.callbacks.common.ispyb_mapping import (
+    populate_data_collection_group,
+    populate_remaining_data_collection_info,
 )
-from mx_bluesky.hyperion.external_interaction.ispyb.data_model import (
+from mx_bluesky.common.external_interaction.ispyb.data_model import (
     DataCollectionInfo,
     DataCollectionPositionInfo,
     ScanDataInfo,
 )
-from mx_bluesky.hyperion.external_interaction.ispyb.ispyb_store import (
+from mx_bluesky.common.external_interaction.ispyb.ispyb_store import (
     IspybIds,
     StoreInIspyb,
 )
-from mx_bluesky.hyperion.log import ISPYB_LOGGER
+from mx_bluesky.common.parameters.components import IspybExperimentType
+from mx_bluesky.common.utils.log import ISPYB_ZOCALO_CALLBACK_LOGGER, set_dcgid_tag
+from mx_bluesky.hyperion.external_interaction.callbacks.rotation.ispyb_mapping import (
+    populate_data_collection_info_for_rotation,
+)
 from mx_bluesky.hyperion.parameters.constants import CONST
 from mx_bluesky.hyperion.parameters.rotation import RotationScan
 
@@ -58,10 +57,10 @@ class RotationISPyBCallback(BaseISPyBCallback):
 
     def activity_gated_start(self, doc: RunStart):
         if doc.get("subplan_name") == CONST.PLAN.ROTATION_OUTER:
-            ISPYB_LOGGER.info(
+            ISPYB_ZOCALO_CALLBACK_LOGGER.info(
                 "ISPyB callback received start document with experiment parameters."
             )
-            hyperion_params = doc.get("hyperion_parameters")
+            hyperion_params = doc.get("mx_bluesky_parameters")
             assert isinstance(hyperion_params, str)
             self.params = RotationScan.model_validate_json(hyperion_params)
             dcgid = (
@@ -73,16 +72,18 @@ class RotationISPyBCallback(BaseISPyBCallback):
                 self.params.ispyb_experiment_type
                 == IspybExperimentType.CHARACTERIZATION
             ):
-                ISPYB_LOGGER.info("Screening collection - using new DCG")
+                ISPYB_ZOCALO_CALLBACK_LOGGER.info(
+                    "Screening collection - using new DCG"
+                )
                 dcgid = None
                 self.last_sample_id = None
             else:
-                ISPYB_LOGGER.info(
+                ISPYB_ZOCALO_CALLBACK_LOGGER.info(
                     f"Collection is {self.params.ispyb_experiment_type} - storing sampleID to bundle images"
                 )
                 self.last_sample_id = self.params.sample_id
             self.ispyb = StoreInIspyb(self.ispyb_config)
-            ISPYB_LOGGER.info("Beginning ispyb deposition")
+            ISPYB_ZOCALO_CALLBACK_LOGGER.info("Beginning ispyb deposition")
             data_collection_group_info = populate_data_collection_group(self.params)
             data_collection_info = populate_data_collection_info_for_rotation(
                 cast(RotationScan, self.params)
@@ -100,7 +101,7 @@ class RotationISPyBCallback(BaseISPyBCallback):
             self.ispyb_ids = self.ispyb.begin_deposition(
                 data_collection_group_info, [scan_data_info]
             )
-        ISPYB_LOGGER.info("ISPYB handler received start document.")
+        ISPYB_ZOCALO_CALLBACK_LOGGER.info("ISPYB handler received start document.")
         if doc.get("subplan_name") == CONST.PLAN.ROTATION_MAIN:
             self.uid_to_finalize_on = doc.get("uid")
         return super().activity_gated_start(doc)
@@ -111,9 +112,9 @@ class RotationISPyBCallback(BaseISPyBCallback):
         event_sourced_position_info: DataCollectionPositionInfo | None,
         params,
     ) -> Sequence[ScanDataInfo]:
-        assert (
-            self.ispyb_ids.data_collection_ids
-        ), "Expect an existing DataCollection to update"
+        assert self.ispyb_ids.data_collection_ids, (
+            "Expect an existing DataCollection to update"
+        )
 
         return [
             ScanDataInfo(
@@ -131,9 +132,9 @@ class RotationISPyBCallback(BaseISPyBCallback):
             doc["data"]["smargon-y"],
             doc["data"]["smargon-z"],
         ]
-        assert (
-            self.params
-        ), "handle_ispyb_hardware_read triggered before activity_gated_start"
+        assert self.params, (
+            "handle_ispyb_hardware_read triggered before activity_gated_start"
+        )
         motor_positions_um = [position * 1000 for position in motor_positions_mm]
         comment = f"Sample position (µm): ({motor_positions_um[0]:.0f}, {motor_positions_um[1]:.0f}, {motor_positions_um[2]:.0f}) {self.params.comment} "
         scan_data_infos[0].data_collection_info.comments = comment

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

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from mx_bluesky.hyperion.external_interaction.ispyb.data_model import DataCollectionInfo
+from mx_bluesky.common.external_interaction.ispyb.data_model import DataCollectionInfo
 from mx_bluesky.hyperion.parameters.rotation import RotationScan
 
 

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

@@ -2,20 +2,22 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from mx_bluesky.hyperion.external_interaction.callbacks.plan_reactive_callback import (
+from mx_bluesky.common.external_interaction.callbacks.common.logging_callback import (
+    format_doc_for_log,
+)
+from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
     PlanReactiveCallback,
 )
-from mx_bluesky.hyperion.external_interaction.nexus.nexus_utils import (
+from mx_bluesky.common.external_interaction.nexus.nexus_utils import (
+    AxisDirection,
     create_beam_and_attenuator_parameters,
     vds_type_based_on_bit_depth,
 )
-from mx_bluesky.hyperion.external_interaction.nexus.write_nexus import NexusWriter
-from mx_bluesky.hyperion.log import NEXUS_LOGGER
+from mx_bluesky.common.external_interaction.nexus.write_nexus import NexusWriter
+from mx_bluesky.common.utils.log import NEXUS_LOGGER
 from mx_bluesky.hyperion.parameters.constants import CONST
 from mx_bluesky.hyperion.parameters.rotation import RotationScan
 
-from ..logging_callback import format_doc_for_log
-
 if TYPE_CHECKING:
     from event_model.documents import Event, EventDescriptor, RunStart
 
@@ -64,7 +66,7 @@ class RotationNexusFileCallback(PlanReactiveCallback):
                 self.writer.attenuator,
             ) = create_beam_and_attenuator_parameters(
                 data["dcm-energy_in_kev"],
-                data["flux_flux_reading"],
+                data["flux-flux_reading"],
                 data["attenuator-actual_transmission"],
             )
             vds_data_type = vds_type_based_on_bit_depth(doc["data"]["eiger_bit_depth"])
@@ -78,7 +80,7 @@ class RotationNexusFileCallback(PlanReactiveCallback):
             self.meta_data_run_number = doc.get("meta_data_run_number")
         if doc.get("subplan_name") == CONST.PLAN.ROTATION_OUTER:
             self.run_uid = doc.get("uid")
-            hyperion_params = doc.get("hyperion_parameters")
+            hyperion_params = doc.get("mx_bluesky_parameters")
             assert isinstance(hyperion_params, str)
             NEXUS_LOGGER.info(
                 f"Nexus writer received start document with experiment parameters {hyperion_params}"
@@ -100,5 +102,7 @@ class RotationNexusFileCallback(PlanReactiveCallback):
                 vds_start_index=parameters.nexus_vds_start_img,
                 full_num_of_images=self.full_num_of_images,
                 meta_data_run_number=self.meta_data_run_number,
-                rotation_direction=parameters.rotation_direction,
+                axis_direction=AxisDirection.NEGATIVE
+                if parameters.features.omega_flip
+                else AxisDirection.POSITIVE,
             )

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

@@ -0,0 +1,50 @@
+from event_model import RunStart, RunStop
+
+from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
+    PlanReactiveCallback,
+)
+from mx_bluesky.common.external_interaction.ispyb.exp_eye_store import (
+    BLSampleStatus,
+    ExpeyeInteraction,
+)
+from mx_bluesky.common.utils.exceptions import CrystalNotFoundException, SampleException
+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."""
+
+    def __init__(self):
+        super().__init__(log=ISPYB_ZOCALO_CALLBACK_LOGGER)
+        self._sample_id: int | None = None
+        self._descriptor: str | None = None
+
+    def activity_gated_start(self, doc: RunStart):
+        if not self._sample_id:
+            sample_id = doc.get("metadata", {}).get("sample_id")
+            self.log.info(f"Recording sample ID at run start {sample_id}")
+            self._sample_id = sample_id
+
+    def activity_gated_stop(self, doc: RunStop) -> RunStop:
+        if doc["exit_status"] != "success":
+            exception_type, message = SampleException.type_and_message_from_reason(
+                doc.get("reason", "")
+            )
+            self.log.info(
+                f"Sample handling callback intercepted exception of type {exception_type}: {message}"
+            )
+            self._record_exception(exception_type)
+        return doc
+
+    def _record_exception(self, exception_type: str):
+        expeye = ExpeyeInteraction()
+        assert self._sample_id, "Unable to record exception due to no sample ID"
+        sample_status = self._decode_sample_status(exception_type)
+        expeye.update_sample_status(self._sample_id, sample_status)
+
+    def _decode_sample_status(self, exception_type: str) -> BLSampleStatus:
+        match exception_type:
+            case SampleException.__name__ | CrystalNotFoundException.__name__:
+                return BLSampleStatus.ERROR_SAMPLE
+        return BLSampleStatus.ERROR_BEAMLINE

mx_bluesky/hyperion/external_interaction/config_server.py

@@ -3,11 +3,24 @@ from functools import cache
 from daq_config_server.client import ConfigServer
 
 from mx_bluesky.common.external_interaction.config_server import FeatureFlags
-from mx_bluesky.hyperion.log import LOGGER
+from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.parameters.constants import CONST
 
 
 class HyperionFeatureFlags(FeatureFlags):
+    """
+    Feature flags specific to Hyperion.
+
+    Attributes:
+        use_panda_for_gridscan:         If True then the PandA is used for gridscans, otherwise the zebra is used
+        compare_cpu_and_gpu_zocalo:     If True then GPU result processing is enabled alongside CPU, if False then
+            CPU only is used.
+        set_stub_offsets:               If True then set the stub offsets after moving to the crystal (ignored for
+            multi-centre)
+        omega_flip:                     If True then invert the smargon omega motor rotation commands with respect to
+         the hyperion request.
+    """
+
     @staticmethod
     @cache
     def get_config_server() -> ConfigServer:
@@ -16,3 +29,4 @@ class HyperionFeatureFlags(FeatureFlags):
     use_panda_for_gridscan: bool = CONST.I03.USE_PANDA_FOR_GRIDSCAN
     compare_cpu_and_gpu_zocalo: bool = CONST.I03.COMPARE_CPU_AND_GPU_ZOCALO
     set_stub_offsets: bool = CONST.I03.SET_STUB_OFFSETS
+    omega_flip: bool = CONST.I03.OMEGA_FLIP

mx_bluesky/hyperion/parameters/components.py

@@ -1,7 +1,8 @@
-from pydantic import BaseModel, Field
+from pydantic import Field
 
+from mx_bluesky.common.parameters.components import WithPandaGridScan
 from mx_bluesky.hyperion.external_interaction.config_server import HyperionFeatureFlags
 
 
-class WithHyperionFeatures(BaseModel):
+class WithHyperionUDCFeatures(WithPandaGridScan):
     features: HyperionFeatureFlags = Field(default=HyperionFeatureFlags())

mx_bluesky/hyperion/parameters/constants.py

@@ -28,6 +28,7 @@ class I03Constants:
     SHUTTER_TIME_S = 0.06
     USE_PANDA_FOR_GRIDSCAN = False
     SET_STUB_OFFSETS = False
+    OMEGA_FLIP = True
 
     # Turns on GPU processing for zocalo and logs a comparison between GPU and CPU-
     # processed results. GPU results never used in analysis for now