mx-bluesky 1.4.2__py3-none-any.whl → 1.4.3__py3-none-any.whl

mx_bluesky/hyperion/experiment_plans/robot_load_then_centre_plan.py

@@ -9,7 +9,7 @@ from blueapi.core import BlueskyContext
 from bluesky import plan_stubs as bps
 from bluesky.utils import MsgGenerator
 from dodal.devices.aperturescatterguard import ApertureScatterguard
-from dodal.devices.attenuator import Attenuator
+from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
 from dodal.devices.dcm import DCM
 from dodal.devices.detector.detector_motion import DetectorMotion
@@ -17,6 +17,7 @@ from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import PandAFastGridScan, ZebraFastGridScan
 from dodal.devices.flux import Flux
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
+from dodal.devices.i03.beamstop import Beamstop
 from dodal.devices.motors import XYZPositioner
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
@@ -29,14 +30,13 @@ from dodal.devices.undulator import Undulator
 from dodal.devices.undulator_dcm import UndulatorDCM
 from dodal.devices.webcam import Webcam
 from dodal.devices.xbpm_feedback import XBPMFeedback
-from dodal.devices.zebra import Zebra
-from dodal.devices.zebra_controlled_shutter import ZebraShutter
+from dodal.devices.zebra.zebra import Zebra
+from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter
 from dodal.devices.zocalo import ZocaloResults
 from dodal.log import LOGGER
 from ophyd_async.fastcs.panda import HDFPanda
 
 from mx_bluesky.common.parameters.constants import OavConstants
-from mx_bluesky.common.parameters.gridscan import RobotLoadThenCentre
 from mx_bluesky.hyperion.device_setup_plans.utils import (
     fill_in_energy_if_not_supplied,
     start_preparing_data_collection_then_do_plan,
@@ -63,13 +63,14 @@ from mx_bluesky.hyperion.experiment_plans.set_energy_plan import (
     set_energy_plan,
 )
 from mx_bluesky.hyperion.parameters.constants import CONST
+from mx_bluesky.hyperion.parameters.robot_load import RobotLoadThenCentre
 
 
 @pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
 class RobotLoadThenCentreComposite:
     # common fields
     xbpm_feedback: XBPMFeedback
-    attenuator: Attenuator
+    attenuator: BinaryFilterAttenuator
 
     # GridDetectThenXRayCentreComposite fields
     aperture_scatterguard: ApertureScatterguard
@@ -101,10 +102,7 @@ class RobotLoadThenCentreComposite:
     robot: BartRobot
     webcam: Webcam
     lower_gonio: XYZPositioner
-
-    @property
-    def sample_motors(self):
-        return self.smargon
+    beamstop: Beamstop
 
 
 def create_devices(context: BlueskyContext) -> RobotLoadThenCentreComposite:
@@ -120,7 +118,7 @@ def _flyscan_plan_from_robot_load_params(
 ):
     yield from pin_centre_then_flyscan_plan(
         cast(GridDetectThenXRayCentreComposite, composite),
-        params.pin_centre_then_xray_centre_params(),
+        params.pin_centre_then_xray_centre_params,
     )
 
 
@@ -131,7 +129,7 @@ def _robot_load_then_flyscan_plan(
 ):
     yield from robot_load_and_change_energy_plan(
         cast(RobotLoadAndEnergyChangeComposite, composite),
-        params.robot_load_params(),
+        params.robot_load_params,
     )
 
     yield from _flyscan_plan_from_robot_load_params(composite, params, oav_config_file)
@@ -211,6 +209,7 @@ def robot_load_then_xray_centre(
     eiger.set_detector_parameters(detector_params)
 
     yield from start_preparing_data_collection_then_do_plan(
+        composite.beamstop,
         eiger,
         composite.detector_motion,
         parameters.detector_distance_mm,

mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py

@@ -8,12 +8,13 @@ import pydantic
 from blueapi.core import BlueskyContext
 from bluesky.utils import MsgGenerator
 from dodal.devices.aperturescatterguard import ApertureScatterguard
-from dodal.devices.attenuator import Attenuator
+from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
 from dodal.devices.dcm import DCM
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.flux import Flux
+from dodal.devices.i03.beamstop import Beamstop
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAVParameters
 from dodal.devices.robot import BartRobot
@@ -22,13 +23,14 @@ from dodal.devices.smargon import Smargon
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.undulator import Undulator
 from dodal.devices.xbpm_feedback import XBPMFeedback
-from dodal.devices.zebra import RotationDirection, Zebra
-from dodal.devices.zebra_controlled_shutter import ZebraShutter
+from dodal.devices.zebra.zebra import RotationDirection, Zebra
+from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter
 from dodal.plan_stubs.check_topup import check_topup_and_wait_if_necessary
 
 from mx_bluesky.common.device_setup_plans.read_hardware_for_setup import (
     read_hardware_for_zocalo,
 )
+from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.device_setup_plans.manipulate_sample import (
     cleanup_sample_environment,
     move_phi_chi_omega,
@@ -55,7 +57,6 @@ from mx_bluesky.hyperion.experiment_plans.oav_snapshot_plan import (
     oav_snapshot_plan,
     setup_beamline_for_OAV,
 )
-from mx_bluesky.hyperion.log import LOGGER
 from mx_bluesky.hyperion.parameters.constants import CONST
 from mx_bluesky.hyperion.parameters.rotation import (
     MultiRotationScan,
@@ -69,8 +70,9 @@ class RotationScanComposite(OavSnapshotComposite):
     """All devices which are directly or indirectly required by this plan"""
 
     aperture_scatterguard: ApertureScatterguard
-    attenuator: Attenuator
+    attenuator: BinaryFilterAttenuator
     backlight: Backlight
+    beamstop: Beamstop
     dcm: DCM
     detector_motion: DetectorMotion
     eiger: EigerDetector
@@ -126,13 +128,26 @@ def calculate_motion_profile(
     See https://github.com/DiamondLightSource/hyperion/wiki/rotation-scan-geometry
     for a simple pictorial explanation."""
 
-    direction = params.rotation_direction.multiplier
+    assert params.rotation_increment_deg > 0
+
+    direction = params.rotation_direction
+    start_scan_deg = params.omega_start_deg
+
+    if params.features.omega_flip:
+        # If omega_flip is True then the motor omega axis is inverted with respect to the
+        # hyperion coordinate system.
+        start_scan_deg = -start_scan_deg
+        direction = (
+            direction.POSITIVE
+            if direction == direction.NEGATIVE
+            else direction.NEGATIVE
+        )
+
     num_images = params.num_images
     shutter_time_s = params.shutter_opening_time_s
     image_width_deg = params.rotation_increment_deg
     exposure_time_s = params.exposure_time_s
     motor_time_to_speed_s *= ACCELERATION_MARGIN
-    start_scan_deg = params.omega_start_deg
 
     LOGGER.info("Calculating rotation scan motion profile:")
     LOGGER.info(
@@ -153,9 +168,9 @@ def calculate_motion_profile(
         f"{acceleration_offset_deg=} = {motor_time_to_speed_s=} * {speed_for_rotation_deg_s=}"
     )
 
-    start_motion_deg = start_scan_deg - (acceleration_offset_deg * direction)
+    start_motion_deg = start_scan_deg - (acceleration_offset_deg * direction.multiplier)
     LOGGER.info(
-        f"{start_motion_deg=} = {start_scan_deg=} - ({acceleration_offset_deg=} * {direction=})"
+        f"{start_motion_deg=} = {start_scan_deg=} - ({acceleration_offset_deg=} * {direction.multiplier=})"
     )
 
     shutter_opening_deg = speed_for_rotation_deg_s * shutter_time_s
@@ -173,7 +188,7 @@ def calculate_motion_profile(
 
     distance_to_move_deg = (
         scan_width_deg + shutter_opening_deg + acceleration_offset_deg * 2
-    ) * direction
+    ) * direction.multiplier
     LOGGER.info(
         f"{distance_to_move_deg=} = ({scan_width_deg=} + {shutter_opening_deg=} + {acceleration_offset_deg=} * 2) * {direction=})"
     )
@@ -183,7 +198,7 @@ def calculate_motion_profile(
         start_motion_deg=start_motion_deg,
         scan_width_deg=scan_width_deg,
         shutter_time_s=shutter_time_s,
-        direction=params.rotation_direction,
+        direction=direction,
         speed_for_rotation_deg_s=speed_for_rotation_deg_s,
         acceleration_offset_deg=acceleration_offset_deg,
         shutter_opening_deg=shutter_opening_deg,
@@ -344,6 +359,8 @@ def rotation_scan(
     parameters: RotationScan,
     oav_params: OAVParameters | None = None,
 ) -> MsgGenerator:
+    parameters.features.update_self_from_server()
+
     if not oav_params:
         oav_params = OAVParameters(context="xrayCentring")
 
@@ -353,7 +370,7 @@ def rotation_scan(
             "subplan_name": CONST.PLAN.ROTATION_OUTER,
             CONST.TRIGGER.ZOCALO: CONST.PLAN.ROTATION_MAIN,
             "zocalo_environment": CONST.ZOCALO_ENV,
-            "hyperion_parameters": parameters.model_dump_json(),
+            "mx_bluesky_parameters": parameters.model_dump_json(),
             "activate_callbacks": [
                 "RotationISPyBCallback",
                 "RotationNexusFileCallback",
@@ -377,6 +394,7 @@ def rotation_scan(
 
         LOGGER.info("setting up and staging eiger...")
         yield from start_preparing_data_collection_then_do_plan(
+            composite.beamstop,
             eiger,
             composite.detector_motion,
             params.detector_distance_mm,
@@ -393,6 +411,7 @@ def multi_rotation_scan(
     parameters: MultiRotationScan,
     oav_params: OAVParameters | None = None,
 ) -> MsgGenerator:
+    parameters.features.update_self_from_server()
     if not oav_params:
         oav_params = OAVParameters(context="xrayCentring")
     eiger: EigerDetector = composite.eiger
@@ -425,8 +444,7 @@ def multi_rotation_scan(
                 md={
                     "subplan_name": CONST.PLAN.ROTATION_OUTER,
                     CONST.TRIGGER.ZOCALO: CONST.PLAN.ROTATION_MAIN,
-                    "zocalo_environment": CONST.ZOCALO_ENV,
-                    "hyperion_parameters": single_scan.model_dump_json(),
+                    "mx_bluesky_parameters": single_scan.model_dump_json(),
                 }
             )
             def rotation_scan_core(
@@ -438,6 +456,7 @@ def multi_rotation_scan(
 
     LOGGER.info("setting up and staging eiger...")
     yield from start_preparing_data_collection_then_do_plan(
+        composite.beamstop,
         eiger,
         composite.detector_motion,
         parameters.detector_distance_mm,

mx_bluesky/hyperion/experiment_plans/set_energy_plan.py

@@ -7,7 +7,7 @@
 
 import pydantic
 from bluesky import plan_stubs as bps
-from dodal.devices.attenuator import Attenuator
+from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.dcm import DCM
 from dodal.devices.focusing_mirror import FocusingMirrorWithStripes, MirrorVoltages
 from dodal.devices.undulator_dcm import UndulatorDCM
@@ -30,7 +30,7 @@ class SetEnergyComposite:
     dcm: DCM
     undulator_dcm: UndulatorDCM
     xbpm_feedback: XBPMFeedback
-    attenuator: Attenuator
+    attenuator: BinaryFilterAttenuator
 
 
 def _set_energy_plan(

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,
 )
@@ -23,21 +37,12 @@ from mx_bluesky.hyperion.external_interaction.callbacks.rotation.nexus_callback
 from mx_bluesky.hyperion.external_interaction.callbacks.sample_handling.sample_handling_callback import (
     SampleHandlingCallback,
 )
-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.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
@@ -46,8 +51,10 @@ 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(),
@@ -58,7 +65,7 @@ def setup_callbacks():
 
 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 == []:
@@ -74,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")
 
 
@@ -94,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,
 )
@@ -14,54 +23,56 @@ from mx_bluesky.hyperion.external_interaction.callbacks.rotation.nexus_callback
 from mx_bluesky.hyperion.external_interaction.callbacks.sample_handling.sample_handling_callback import (
     SampleHandlingCallback,
 )
-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.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,
-        SampleHandlingCallback,
-    ]
-):
+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()),

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

@@ -2,18 +2,18 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-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:
@@ -22,18 +22,23 @@ 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")
             self._metadata = doc.get("metadata")
             assert isinstance(self._metadata, dict)
@@ -59,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"]
@@ -73,11 +78,13 @@ 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"
+            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."

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