mx-bluesky 1.5.8__py3-none-any.whl → 1.5.9__py3-none-any.whl

mx_bluesky/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.5.8'
-__version_tuple__ = version_tuple = (1, 5, 8)
+__version__ = version = '1.5.9'
+__version_tuple__ = version_tuple = (1, 5, 9)
 
 __commit_id__ = commit_id = None

mx_bluesky/beamlines/i04/experiment_plans/i04_grid_detect_then_xray_centre_plan.py

@@ -6,7 +6,7 @@ import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
 from bluesky.utils import MsgGenerator
 from dodal.common import inject
-from dodal.devices.aperturescatterguard import ApertureScatterguard
+from dodal.devices.aperturescatterguard import ApertureScatterguard, ApertureValue
 from dodal.devices.attenuator.attenuator import BinaryFilterAttenuator
 from dodal.devices.backlight import Backlight
 from dodal.devices.common_dcm import BaseDCM
@@ -17,6 +17,7 @@ from dodal.devices.fast_grid_scan import (
     set_fast_grid_scan_params,
 )
 from dodal.devices.flux import Flux
+from dodal.devices.i04.transfocator import Transfocator
 from dodal.devices.mx_phase1.beamstop import Beamstop
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
@@ -33,6 +34,10 @@ from dodal.plans.preprocessors.verify_undulator_gap import (
     verify_undulator_gap_before_run_decorator,
 )
 
+from mx_bluesky.common.device_setup_plans.setup_zebra_and_shutter import (
+    setup_zebra_for_gridscan,
+    tidy_up_zebra_after_gridscan,
+)
 from mx_bluesky.common.experiment_plans.common_flyscan_xray_centre_plan import (
     BeamlineSpecificFGSFeatures,
     construct_beamline_specific_FGS_features,
@@ -67,10 +72,22 @@ from mx_bluesky.common.preprocessors.preprocessors import (
     transmission_and_xbpm_feedback_for_collection_decorator,
 )
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.phase1_zebra.device_setup_plans.setup_zebra import (
-    setup_zebra_for_gridscan,
-    tidy_up_zebra_after_gridscan,
-)
+
+DEFAULT_BEAMSIZE_MICRONS = 20
+
+
+def _change_beamsize(
+    transfocator: Transfocator, beamsize: float, parameters: GridCommon
+):
+    """i04 always uses the large aperture and changes beamsize with the transfocator.
+
+    An aperture is needed to reduce scatter but the transfocator is best used for beamsize
+    changes as it gives more flux compared to a bigger beam with a small aperture.
+    """
+    parameters.selected_aperture = ApertureValue.LARGE
+    yield from bps.abs_set(
+        transfocator, beamsize, group=PlanGroupCheckpointConstants.GRID_READY_FOR_DC
+    )
 
 
 # See https://github.com/DiamondLightSource/blueapi/issues/506 for using device composites
@@ -96,6 +113,7 @@ def i04_grid_detect_then_xray_centre(
     zocalo: ZocaloResults = inject("zocalo"),
     smargon: Smargon = inject("smargon"),
     detector_motion: DetectorMotion = inject("detector_motion"),
+    transfocator: Transfocator = inject("transfocator"),
     oav_config: str = OavConstants.OAV_CONFIG_JSON,
     udc: bool = False,
 ) -> MsgGenerator:
@@ -108,7 +126,7 @@ def i04_grid_detect_then_xray_centre(
 
 
     i04's implementation of this plan is very similar to Hyperion. However, since i04
-    isn't running in a continious Bluesky UDC loop, we take additional steps in beamline
+    isn't running in a continuous Bluesky UDC loop, we take additional steps in beamline
     tidy-up.
     """
 
@@ -134,8 +152,9 @@ def i04_grid_detect_then_xray_centre(
         robot,
         sample_shutter,
     )
+    initial_beamsize = yield from bps.rd(transfocator.beamsize_set_microns)
 
-    def tidy_beamline_if_not_udc():
+    def tidy_beamline():
         if not udc:
             yield from get_ready_for_oav_and_close_shutter(
                 composite.smargon,
@@ -143,8 +162,9 @@ def i04_grid_detect_then_xray_centre(
                 composite.aperture_scatterguard,
                 composite.detector_motion,
             )
+        yield from bps.mv(transfocator, initial_beamsize)
 
-    @bpp.finalize_decorator(tidy_beamline_if_not_udc)
+    @bpp.finalize_decorator(tidy_beamline)
     def _inner_grid_detect_then_xrc():
         # These callbacks let us talk to ISPyB and Nexgen. They aren't included in the common plan because
         # Hyperion handles its callbacks differently to BlueAPI-managed plans, see
@@ -167,6 +187,7 @@ def i04_grid_detect_then_xray_centre(
 
         yield from grid_detect_then_xray_centre_with_callbacks()
 
+    yield from _change_beamsize(transfocator, DEFAULT_BEAMSIZE_MICRONS, parameters)
     yield from _inner_grid_detect_then_xrc()
 
 
@@ -178,7 +199,7 @@ def get_ready_for_oav_and_close_shutter(
 ):
     yield from bps.wait(PlanGroupCheckpointConstants.GRID_READY_FOR_DC)
     group = "get_ready_for_oav_and_close_shutter"
-    LOGGER.info("Non-udc tidy: Seting up beamline for OAV")
+    LOGGER.info("Non-udc tidy: Setting up beamline for OAV")
     yield from setup_beamline_for_OAV(
         smargon, backlight, aperture_scatterguard, group=group
     )
@@ -247,7 +268,9 @@ def construct_i04_specific_features(
     )
     fgs_motors = xrc_composite.zebra_fast_grid_scan
     return construct_beamline_specific_FGS_features(
-        setup_zebra_for_gridscan,
+        partial(
+            setup_zebra_for_gridscan,
+        ),
         tidy_plan,
         set_flyscan_params_plan,
         fgs_motors,

mx_bluesky/common/device_setup_plans/manipulate_sample.py

@@ -9,8 +9,8 @@ from dodal.devices.backlight import Backlight, InOut
 from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.smargon import CombinedMove, Smargon
 
+from mx_bluesky.common.parameters.constants import PlanGroupCheckpointConstants
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.hyperion.parameters.constants import CONST
 
 LOWER_DETECTOR_SHUTTER_AFTER_SCAN = True
 
@@ -48,7 +48,7 @@ def move_aperture_if_required(
 
     else:
         LOGGER.info(f"Setting aperture position to {aperture_value}")
-        yield from bps.wait(CONST.WAIT.PREPARE_APERTURE)
+        yield from bps.wait(PlanGroupCheckpointConstants.PREPARE_APERTURE)
         yield from bps.abs_set(
             aperture_scatterguard.selected_aperture,
             aperture_value,

mx_bluesky/common/device_setup_plans/robot_load_unload.py

@@ -9,8 +9,12 @@ from dodal.devices.robot import BartRobot
 from dodal.devices.smargon import CombinedMove, Smargon, StubPosition
 from dodal.plan_stubs.motor_utils import MoveTooLarge, home_and_reset_wrapper
 
+from mx_bluesky.common.parameters.constants import (
+    DocDescriptorNames,
+    HardwareConstants,
+    PlanNameConstants,
+)
 from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.hyperion.parameters.constants import CONST
 
 SLEEP_PER_CHECK = 0.1
 
@@ -60,7 +64,7 @@ def do_plan_while_lower_gonio_at_home(plan: MsgGenerator, lower_gonio: XYZStage)
             plan,
             lower_gonio,
             BartRobot.LOAD_TOLERANCE_MM,
-            CONST.HARDWARE.CRYOJET_MARGIN_MM,
+            HardwareConstants.CRYOJET_MARGIN_MM,
             "lower_gonio",
             wait_for_all=False,
         ),
@@ -100,7 +104,7 @@ def robot_unload(
 
     @bpp.run_decorator(
         md={
-            "subplan_name": CONST.PLAN.ROBOT_UNLOAD,
+            "subplan_name": PlanNameConstants.ROBOT_UNLOAD,
             "metadata": {"visit": visit, "sample_id": sample_id},
             "activate_callbacks": [
                 "RobotLoadISPyBCallback",
@@ -108,7 +112,7 @@ def robot_unload(
         },
     )
     def do_robot_unload_and_send_to_ispyb():
-        yield from bps.create(name=CONST.DESCRIPTORS.ROBOT_UPDATE)
+        yield from bps.create(name=DocDescriptorNames.ROBOT_UPDATE)
         yield from bps.read(robot)
         yield from bps.save()
 

mx_bluesky/common/device_setup_plans/setup_zebra_and_shutter.py

@@ -0,0 +1,245 @@
+from typing import Protocol, runtime_checkable
+
+import bluesky.plan_stubs as bps
+from bluesky.utils import MsgGenerator
+from dodal.devices.zebra.zebra import (
+    ArmDemand,
+    EncEnum,
+    I03Axes,
+    RotationDirection,
+    Zebra,
+)
+from dodal.devices.zebra.zebra_controlled_shutter import (
+    ZebraShutter,
+    ZebraShutterControl,
+)
+
+from mx_bluesky.common.parameters.constants import ZEBRA_STATUS_TIMEOUT
+from mx_bluesky.common.utils.log import LOGGER
+
+"""Plans in this file will work as intended if the zebra has the following configuration:
+- A fast shutter is connected through TTL inputs from the Zebra.
+- When the zebra shutter is set to auto mode, the IOC sets the Zebra's SOFT_IN1 signal high.
+- When the zebra shutter is set to manual mode, the IOC sets the Zebra's SOFT_IN1 signal low.
+"""
+
+
+@runtime_checkable
+class GridscanSetupDevices(Protocol):
+    zebra: Zebra
+    sample_shutter: ZebraShutter
+
+
+def setup_zebra_for_gridscan(
+    composite: GridscanSetupDevices,  # XRC gridscan's generic trigger setup expects a composite rather than individual devices
+    group="setup_zebra_for_gridscan",
+    wait=True,
+    ttl_input_for_detector_to_use: None | int = None,
+) -> MsgGenerator:
+    """
+    Configure the zebra for an MX XRC gridscan by allowing the zebra to trigger the fast shutter and detector via signals
+    sent from the motion controller.
+
+    Args:
+        composite: Composite device containing a zebra and zebra shutter
+        group: Bluesky group to use when waiting on completion
+        wait: If true, block until completion
+        ttl_input_for_detector_to_use: If the zebra isn't using the TTL_DETECTOR zebra input, manually
+        specify which TTL input is being used for the desired detector
+
+    This plan assumes that the motion controller, as part of its gridscan PLC, will send triggers as required to the zebra's
+    IN4_TTL and IN3_TTL to control the fast_shutter and detector respectively
+
+    """
+    zebra = composite.zebra
+    ttl_detector = ttl_input_for_detector_to_use or zebra.mapping.outputs.TTL_DETECTOR
+    # Set shutter to automatic and to trigger via motion controller GPIO signal (IN4_TTL)
+    yield from configure_zebra_and_shutter_for_auto_shutter(
+        zebra, composite.sample_shutter, zebra.mapping.sources.IN4_TTL, group=group
+    )
+
+    yield from bps.abs_set(
+        zebra.output.out_pvs[ttl_detector],
+        zebra.mapping.sources.IN3_TTL,
+        group=group,
+    )
+
+    if wait:
+        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
+
+
+def set_shutter_auto_input(zebra: Zebra, input: int, group="set_shutter_trigger"):
+    """Set the signal that controls the shutter. We use the second input to the
+    Zebra's AND_GATE_FOR_AUTO_SHUTTER for this input. ZebraShutter control mode must be in auto for this input to take control
+
+    For more details see the ZebraShutter device."""
+    auto_gate = zebra.mapping.AND_GATE_FOR_AUTO_SHUTTER
+    auto_shutter_control = zebra.logic_gates.and_gates[auto_gate]
+    yield from bps.abs_set(auto_shutter_control.sources[2], input, group)
+
+
+def configure_zebra_and_shutter_for_auto_shutter(
+    zebra: Zebra, zebra_shutter: ZebraShutter, input: int, group="use_automatic_shutter"
+):
+    """Set the shutter to auto mode, and configure the zebra to trigger the shutter on
+    an input source. For the input, use one of the source constants in zebra.py
+
+    When the shutter is in auto/manual, logic in EPICS sets the Zebra's
+    SOFT_IN1 to low/high respectively. The Zebra's AND_GATE_FOR_AUTO_SHUTTER should be used to control the shutter while in auto mode.
+    To do this, we need (AND_GATE_FOR_AUTO_SHUTTER = SOFT_IN1 AND input), where input is the zebra signal we want to control the shutter when in auto mode.
+    """
+
+    # Set shutter to auto mode
+    yield from bps.abs_set(
+        zebra_shutter.control_mode, ZebraShutterControl.AUTO, group=group
+    )
+
+    auto_gate = zebra.mapping.AND_GATE_FOR_AUTO_SHUTTER
+
+    # Set first input of AND_GATE_FOR_AUTO_SHUTTER to SOFT_IN1, which is high when shutter is in auto mode
+    # Note the Zebra should ALWAYS be setup this way. See https://github.com/DiamondLightSource/mx-bluesky/issues/551
+    yield from bps.abs_set(
+        zebra.logic_gates.and_gates[auto_gate].sources[1],
+        zebra.mapping.sources.SOFT_IN1,
+        group=group,
+    )
+
+    # Set the second input of AND_GATE_FOR_AUTO_SHUTTER to the requested zebra input source
+    yield from set_shutter_auto_input(zebra, input, group=group)
+
+
+def tidy_up_zebra_after_gridscan(
+    zebra: Zebra,
+    zebra_shutter: ZebraShutter,
+    group="tidy_up_zebra_after_gridscan",
+    wait=True,
+    ttl_input_for_detector_to_use: int | None = None,
+) -> MsgGenerator:
+    """
+    Set the zebra back to a state which is expected by GDA.
+
+    Args:
+        zebra: Zebra device.
+        zebra_shutter: Zebra shutter device.
+        group: Bluesky group to use when waiting on completion.
+        wait: If true, block until completion.
+        ttl_input_for_detector_to_use: If the zebra isn't using the TTL_DETECTOR zebra input, manually
+        specify which TTL input is being used for the desired detector.
+    """
+
+    LOGGER.info("Tidying up Zebra")
+
+    ttl_detector = ttl_input_for_detector_to_use or zebra.mapping.outputs.TTL_DETECTOR
+
+    yield from bps.abs_set(
+        zebra.output.out_pvs[ttl_detector],
+        zebra.mapping.sources.PC_PULSE,
+        group=group,
+    )
+    yield from bps.abs_set(
+        zebra_shutter.control_mode, ZebraShutterControl.MANUAL, group=group
+    )
+    yield from set_shutter_auto_input(zebra, zebra.mapping.sources.PC_GATE, group=group)
+
+    if wait:
+        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
+
+
+def setup_zebra_for_rotation(
+    zebra: Zebra,
+    zebra_shutter: ZebraShutter,
+    axis: EncEnum = I03Axes.OMEGA,
+    start_angle: float = 0,
+    scan_width: float = 360,
+    shutter_opening_deg: float = 2.5,
+    shutter_opening_s: float = 0.04,
+    direction: RotationDirection = RotationDirection.POSITIVE,
+    group: str = "setup_zebra_for_rotation",
+    wait: bool = True,
+    ttl_input_for_detector_to_use: int | None = None,
+):
+    """Set up the Zebra to collect a rotation dataset. Any plan using this is
+    responsible for setting the smargon velocity appropriately so that the desired
+    image width is achieved with the exposure time given here.
+
+    Parameters:
+        zebra:              The zebra device to use
+        axis:               Encoder enum representing which axis to use for position
+                            compare. Currently always omega.
+        start_angle:        Position at which the scan should begin, in degrees.
+        scan_width:         Total angle through which to collect, in degrees.
+        shutter_opening_deg:How many degrees of rotation it takes for the fast shutter
+                            to open. Increases the gate width.
+        shutter_opening_s:  How many seconds it takes for the fast shutter to open. The
+                            detector pulse is delayed after the shutter signal by this
+                            amount.
+        direction:          RotationDirection enum for positive or negative.
+                            Defaults to Positive.
+        group:              A name for the group of statuses generated
+        wait:               Block until all the settings have completed
+        ttl_input_for_detector_to_use: If the zebra isn't using the TTL_DETECTOR zebra input,
+                            manually specify which TTL input is being used for the desired detector
+    """
+
+    ttl_detector = ttl_input_for_detector_to_use or zebra.mapping.outputs.TTL_DETECTOR
+
+    if not isinstance(direction, RotationDirection):
+        raise ValueError(
+            "Disallowed rotation direction provided to Zebra setup plan. "
+            "Use RotationDirection.POSITIVE or RotationDirection.NEGATIVE."
+        )
+    yield from bps.abs_set(zebra.pc.dir, direction.value, group=group)
+    LOGGER.info("ZEBRA SETUP: START")
+    # Set gate start, adjust for shutter opening time if necessary
+    LOGGER.info(f"ZEBRA SETUP: degrees to adjust for shutter = {shutter_opening_deg}")
+    LOGGER.info(f"ZEBRA SETUP: start angle start: {start_angle}")
+    LOGGER.info(f"ZEBRA SETUP: start angle adjusted, gate start set to: {start_angle}")
+    yield from bps.abs_set(zebra.pc.gate_start, start_angle, group=group)
+    # set gate width to total width
+    yield from bps.abs_set(
+        zebra.pc.gate_width, scan_width + shutter_opening_deg, group=group
+    )
+    LOGGER.info(
+        f"Pulse start set to shutter open time, set to: {abs(shutter_opening_s)}"
+    )
+    yield from bps.abs_set(zebra.pc.pulse_start, abs(shutter_opening_s), group=group)
+    # Set gate position to be angle of interest
+    yield from bps.abs_set(zebra.pc.gate_trigger, axis.value, group=group)
+    # Set shutter to automatic and to trigger via PC_GATE
+    yield from configure_zebra_and_shutter_for_auto_shutter(
+        zebra, zebra_shutter, zebra.mapping.sources.PC_GATE, group=group
+    )
+    # Trigger the detector with a pulse
+    yield from bps.abs_set(
+        zebra.output.out_pvs[ttl_detector],
+        zebra.mapping.sources.PC_PULSE,
+        group=group,
+    )
+
+    LOGGER.info(f"ZEBRA SETUP: END - {'' if wait else 'not'} waiting for completion")
+    if wait:
+        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
+
+
+def tidy_up_zebra_after_rotation_scan(
+    zebra: Zebra,
+    zebra_shutter: ZebraShutter,
+    group="tidy_up_zebra_after_rotation",
+    wait=True,
+):
+    """
+    Set the zebra back to a state which is expected by GDA.
+
+    Args:
+        zebra: Zebra device.
+        zebra_shutter: Zebra shutter device.
+        group: Bluesky group to use when waiting on completion.
+        wait: If true, block until completion.
+    """
+
+    yield from bps.abs_set(zebra.pc.arm, ArmDemand.DISARM, group=group)
+    yield from bps.abs_set(
+        zebra_shutter.control_mode, ZebraShutterControl.MANUAL, group=group
+    )
+    if wait:
+        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)

mx_bluesky/common/experiment_plans/common_flyscan_xray_centre_plan.py

@@ -8,11 +8,12 @@ import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
 import numpy as np
 from bluesky.protocols import Readable
-from bluesky.utils import MsgGenerator
+from bluesky.utils import FailedStatus, MsgGenerator
 from dodal.common.beamlines.commissioning_mode import read_commissioning_mode
 from dodal.devices.fast_grid_scan import (
     FastGridScanCommon,
     FastGridScanThreeD,
+    GridScanInvalidException,
 )
 from dodal.devices.zocalo import ZocaloResults
 from dodal.devices.zocalo.zocalo_results import (
@@ -270,10 +271,14 @@ def run_gridscan(
         yield from beamline_specific.read_pre_flyscan_plan()
 
     LOGGER.info("Setting fgs params")
-    yield from beamline_specific.set_flyscan_params_plan()
 
-    LOGGER.info("Waiting for gridscan validity check")
-    yield from wait_for_gridscan_valid(beamline_specific.fgs_motors)
+    try:
+        yield from beamline_specific.set_flyscan_params_plan()
+    except FailedStatus as e:
+        if isinstance(e.__cause__, GridScanInvalidException):
+            raise SampleException(
+                "Scan invalid - gridscan not valid for detected pin position"
+            ) from e
 
     LOGGER.info("Waiting for arming to finish")
     yield from bps.wait(PlanGroupCheckpointConstants.GRID_READY_FOR_DC)
@@ -293,23 +298,6 @@ def run_gridscan(
         yield from bps.abs_set(beamline_specific.fgs_motors.z_steps, 0, wait=False)
 
 
-def wait_for_gridscan_valid(fgs_motors: FastGridScanCommon, timeout=0.5):
-    LOGGER.info("Waiting for valid fgs_params")
-    SLEEP_PER_CHECK = 0.1
-    times_to_check = int(timeout / SLEEP_PER_CHECK)
-    for _ in range(times_to_check):
-        scan_invalid = yield from bps.rd(fgs_motors.scan_invalid)
-        pos_counter = yield from bps.rd(fgs_motors.position_counter)
-        LOGGER.debug(
-            f"Scan invalid: {scan_invalid} and position counter: {pos_counter}"
-        )
-        if not scan_invalid and pos_counter == 0:
-            LOGGER.info("Gridscan scan valid and position counter reset")
-            return
-        yield from bps.sleep(SLEEP_PER_CHECK)
-    raise SampleException("Scan invalid - pin too long/short/bent and out of range")
-
-
 def _xrc_result_in_boxes_to_result_in_mm(
     xrc_result: XrcResult, parameters: SpecifiedThreeDGridScan
 ) -> XRayCentreResult:

mx_bluesky/common/experiment_plans/inner_plans/do_fgs.py

@@ -94,8 +94,10 @@ def kickoff_and_complete_gridscan(
         md={
             "subplan_name": plan_name,
             "omega_to_scan_spec": {
-                GridscanPlane.OMEGA_XY: scan_points[0],
-                GridscanPlane.OMEGA_XZ: scan_points[1],
+                # These have to be cast to strings due to a bug in orsjon. See
+                # https://github.com/ijl/orjson/issues/414
+                str(GridscanPlane.OMEGA_XY): scan_points[0],
+                str(GridscanPlane.OMEGA_XZ): scan_points[1],
             },
         }
     )

mx_bluesky/common/external_interaction/callbacks/common/ispyb_mapping.py

@@ -50,9 +50,10 @@ def populate_remaining_data_collection_info(
     data_collection_info.xbeam = beam_position[0]
     data_collection_info.ybeam = beam_position[1]
     data_collection_info.start_time = get_current_time_string()
-    # temporary file template until nxs filewriting is integrated and we can use
-    # that file name
-    data_collection_info.file_template = f"{params.detector_params.prefix}_{data_collection_info.data_collection_number}_master.h5"
+    if data_collection_info.data_collection_number is not None:
+        # Do not write the file template if we don't have sufficient information - for gridscans we  may not
+        # know the data collection number until later
+        data_collection_info.file_template = f"{params.detector_params.prefix}_{data_collection_info.data_collection_number}_master.h5"
     return data_collection_info
 
 

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

@@ -105,6 +105,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
         self._start_of_fgs_uid: str | None = None
         self._processing_start_time: float | None = None
         self._grid_plane_to_id_map: dict[GridscanPlane, int] = {}
+        self._grid_plane_to_width_map: dict[GridscanPlane, int] = {}
         self.data_collection_group_info: DataCollectionGroupInfo | None
 
     def activity_gated_start(self, doc: RunStart):
@@ -131,9 +132,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
                     data_collection_info=populate_remaining_data_collection_info(
                         "MX-Bluesky: Xray centring 1 -",
                         None,
-                        DataCollectionInfo(
-                            data_collection_number=self.params.detector_params.run_number,
-                        ),
+                        DataCollectionInfo(),
                         self.params,
                     ),
                 ),
@@ -141,11 +140,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
                     data_collection_info=populate_remaining_data_collection_info(
                         "MX-Bluesky: Xray centring 2 -",
                         None,
-                        DataCollectionInfo(
-                            data_collection_number=(
-                                self.params.detector_params.run_number + 1
-                            ),
-                        ),
+                        DataCollectionInfo(),
                         self.params,
                     )
                 ),
@@ -192,6 +187,15 @@ class GridscanISPyBCallback(BaseISPyBCallback):
         assert self.params, "ISPyB handler didn't receive parameters!"
         assert self.data_collection_group_info, "No data collection group"
         data = doc["data"]
+        omega = doc["data"]["smargon-omega"]
+        grid_plane = _smargon_omega_to_xyxz_plane(omega)
+        ISPYB_ZOCALO_CALLBACK_LOGGER.info(
+            f"Generating dc info for gridplane {grid_plane}, omega {omega}"
+        )
+        data_collection_number = self.data_collection_number_from_gridplane(grid_plane)
+        file_template = (
+            f"{self.params.detector_params.prefix}_{data_collection_number}_master.h5"
+        )
         data_collection_info = DataCollectionInfo(
             xtal_snapshot1=data.get("oav-grid_snapshot-last_path_full_overlay"),
             xtal_snapshot2=data.get("oav-grid_snapshot-last_path_outer"),
@@ -200,6 +204,8 @@ class GridscanISPyBCallback(BaseISPyBCallback):
                 data["oav-grid_snapshot-num_boxes_x"]
                 * data["oav-grid_snapshot-num_boxes_y"]
             ),
+            data_collection_number=data_collection_number,
+            file_template=file_template,
         )
         microns_per_pixel_x = data["oav-microns_per_pixel_x"]
         microns_per_pixel_y = data["oav-microns_per_pixel_y"]
@@ -219,21 +225,22 @@ class GridscanISPyBCallback(BaseISPyBCallback):
             data_collection_grid_info
         )
 
-        if self.data_collection_group_info.comments:
-            self.data_collection_group_info.comments += (
-                f"by {data_collection_grid_info.steps_y}."
-            )
-        else:
-            self.data_collection_group_info.comments = (
-                f"Diffraction grid scan of "
-                f"{data_collection_grid_info.steps_x} "
-                f"by {data_collection_grid_info.steps_y} "
-            )
-
+        # Snapshots may be triggered in a different order to gridscans, so save
+        # the mapping to the data collection id in order to trigger Zocalo correctly.
         data_collection_id = self.ispyb_ids.data_collection_ids[
-            self._oav_snapshot_event_idx
+            0 if grid_plane == GridscanPlane.OMEGA_XY else 1
         ]
-        self._populate_axis_info(data_collection_info, doc["data"]["smargon-omega"])
+        self._grid_plane_to_id_map[grid_plane] = data_collection_id
+        self._grid_plane_to_width_map[grid_plane] = data_collection_grid_info.steps_y
+
+        y_steps = self._grid_plane_to_width_map.get(GridscanPlane.OMEGA_XY, "_")
+        z_steps = self._grid_plane_to_width_map.get(GridscanPlane.OMEGA_XZ, "_")
+        self.data_collection_group_info.comments = (
+            f"Diffraction grid scan of {data_collection_grid_info.steps_x} by "
+            f"{y_steps} by {z_steps}."
+        )
+
+        self._populate_axis_info(data_collection_info, omega)
 
         scan_data_info = ScanDataInfo(
             data_collection_info=data_collection_info,
@@ -243,10 +250,6 @@ class GridscanISPyBCallback(BaseISPyBCallback):
         ISPYB_ZOCALO_CALLBACK_LOGGER.info(
             "Updating ispyb data collection after oav snapshot."
         )
-        grid_plane = _smargon_omega_to_xyxz_plane(doc["data"]["smargon-omega"])
-        # Snapshots may be triggered in a different order to gridscans, so save
-        # the mapping to the data collection id in order to trigger Zocalo correctly.
-        self._grid_plane_to_id_map[grid_plane] = data_collection_id
 
         self._oav_snapshot_event_idx += 1
         return [scan_data_info]
@@ -315,6 +318,7 @@ class GridscanISPyBCallback(BaseISPyBCallback):
             )
             self.data_collection_group_info = None
             self._grid_plane_to_id_map.clear()
+            self._grid_plane_to_width_map.clear()
             return super().activity_gated_stop(doc)
         return self.tag_doc(doc)
 
@@ -325,6 +329,11 @@ class GridscanISPyBCallback(BaseISPyBCallback):
             doc["grid_plane_to_id_map"] = self._grid_plane_to_id_map
         return doc  # type: ignore
 
+    def data_collection_number_from_gridplane(self, plane) -> int:
+        assert self.params
+        base_number = self.params.detector_params.run_number
+        return base_number if plane == GridscanPlane.OMEGA_XY else base_number + 1
+
 
 def generate_start_info_from_omega_map() -> ZocaloInfoGenerator:
     """

mx_bluesky/hyperion/device_setup_plans/setup_zebra.py

@@ -1,120 +1,22 @@
 import bluesky.plan_stubs as bps
 from dodal.devices.zebra.zebra import (
     ArmDemand,
-    EncEnum,
-    I03Axes,
-    RotationDirection,
     Zebra,
 )
 from dodal.devices.zebra.zebra_controlled_shutter import (
     ZebraShutter,
-    ZebraShutterControl,
 )
 
-from mx_bluesky.common.parameters.constants import ZEBRA_STATUS_TIMEOUT
-from mx_bluesky.common.utils.log import LOGGER
-from mx_bluesky.phase1_zebra.device_setup_plans.setup_zebra import (
+from mx_bluesky.common.device_setup_plans.setup_zebra_and_shutter import (
     configure_zebra_and_shutter_for_auto_shutter,
 )
+from mx_bluesky.common.parameters.constants import ZEBRA_STATUS_TIMEOUT
 
 
 def arm_zebra(zebra: Zebra):
     yield from bps.abs_set(zebra.pc.arm, ArmDemand.ARM, wait=True)
 
 
-def tidy_up_zebra_after_rotation_scan(
-    zebra: Zebra,
-    zebra_shutter: ZebraShutter,
-    group="tidy_up_zebra_after_rotation",
-    wait=True,
-):
-    yield from bps.abs_set(zebra.pc.arm, ArmDemand.DISARM, group=group)
-    yield from bps.abs_set(
-        zebra_shutter.control_mode, ZebraShutterControl.MANUAL, group=group
-    )
-    if wait:
-        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
-
-
-def setup_zebra_for_rotation(
-    zebra: Zebra,
-    zebra_shutter: ZebraShutter,
-    axis: EncEnum = I03Axes.OMEGA,
-    start_angle: float = 0,
-    scan_width: float = 360,
-    shutter_opening_deg: float = 2.5,
-    shutter_opening_s: float = 0.04,
-    direction: RotationDirection = RotationDirection.POSITIVE,
-    group: str = "setup_zebra_for_rotation",
-    wait: bool = True,
-):
-    """Set up the Zebra to collect a rotation dataset. Any plan using this is
-    responsible for setting the smargon velocity appropriately so that the desired
-    image width is achieved with the exposure time given here.
-
-    Parameters:
-        zebra:              The zebra device to use
-        axis:               I03 axes enum representing which axis to use for position
-                            compare. Currently always omega.
-        start_angle:        Position at which the scan should begin, in degrees.
-        scan_width:         Total angle through which to collect, in degrees.
-        shutter_opening_deg:How many degrees of rotation it takes for the fast shutter
-                            to open. Increases the gate width.
-        shutter_opening_s:  How many seconds it takes for the fast shutter to open. The
-                            detector pulse is delayed after the shutter signal by this
-                            amount.
-        direction:          RotationDirection enum for positive or negative.
-                            Defaults to Positive.
-        group:              A name for the group of statuses generated
-        wait:               Block until all the settings have completed
-    """
-
-    if not isinstance(direction, RotationDirection):
-        raise ValueError(
-            "Disallowed rotation direction provided to Zebra setup plan. "
-            "Use RotationDirection.POSITIVE or RotationDirection.NEGATIVE."
-        )
-    yield from bps.abs_set(zebra.pc.dir, direction.value, group=group)
-    LOGGER.info("ZEBRA SETUP: START")
-    # Set gate start, adjust for shutter opening time if necessary
-    LOGGER.info(f"ZEBRA SETUP: degrees to adjust for shutter = {shutter_opening_deg}")
-    LOGGER.info(f"ZEBRA SETUP: start angle start: {start_angle}")
-    LOGGER.info(f"ZEBRA SETUP: start angle adjusted, gate start set to: {start_angle}")
-    yield from bps.abs_set(zebra.pc.gate_start, start_angle, group=group)
-    # set gate width to total width
-    yield from bps.abs_set(
-        zebra.pc.gate_width, scan_width + shutter_opening_deg, group=group
-    )
-    LOGGER.info(
-        f"Pulse start set to shutter open time, set to: {abs(shutter_opening_s)}"
-    )
-    yield from bps.abs_set(zebra.pc.pulse_start, abs(shutter_opening_s), group=group)
-    # Set gate position to be angle of interest
-    yield from bps.abs_set(zebra.pc.gate_trigger, axis.value, group=group)
-    # Set shutter to automatic and to trigger via PC_GATE
-    yield from configure_zebra_and_shutter_for_auto_shutter(
-        zebra, zebra_shutter, zebra.mapping.sources.PC_GATE, group=group
-    )
-    # Trigger the detector with a pulse
-    yield from bps.abs_set(
-        zebra.output.out_pvs[zebra.mapping.outputs.TTL_DETECTOR],
-        zebra.mapping.sources.PC_PULSE,
-        group=group,
-    )
-    # Don't use the fluorescence detector
-    yield from bps.abs_set(
-        zebra.output.out_pvs[zebra.mapping.outputs.TTL_XSPRESS3],
-        zebra.mapping.sources.DISCONNECT,
-        group=group,
-    )
-    yield from bps.abs_set(
-        zebra.output.pulse_1.input, zebra.mapping.sources.DISCONNECT, group=group
-    )
-    LOGGER.info(f"ZEBRA SETUP: END - {'' if wait else 'not'} waiting for completion")
-    if wait:
-        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
-
-
 def setup_zebra_for_panda_flyscan(
     zebra: Zebra,
     zebra_shutter: ZebraShutter,

mx_bluesky/hyperion/experiment_plans/hyperion_flyscan_xray_centre_plan.py

@@ -10,6 +10,10 @@ from dodal.devices.fast_grid_scan import (
     set_fast_grid_scan_params,
 )
 
+from mx_bluesky.common.device_setup_plans.setup_zebra_and_shutter import (
+    setup_zebra_for_gridscan,
+    tidy_up_zebra_after_gridscan,
+)
 from mx_bluesky.common.experiment_plans.common_flyscan_xray_centre_plan import (
     construct_beamline_specific_FGS_features,
 )
@@ -29,10 +33,6 @@ from mx_bluesky.hyperion.parameters.device_composites import (
     HyperionFlyScanXRayCentreComposite,
 )
 from mx_bluesky.hyperion.parameters.gridscan import HyperionSpecifiedThreeDGridScan
-from mx_bluesky.phase1_zebra.device_setup_plans.setup_zebra import (
-    setup_zebra_for_gridscan,
-    tidy_up_zebra_after_gridscan,
-)
 
 
 class SmargonSpeedException(Exception):
@@ -78,7 +78,9 @@ def construct_hyperion_specific_features(
         fgs_motors = xrc_composite.panda_fast_grid_scan
 
     else:
-        setup_trigger_plan = setup_zebra_for_gridscan
+        setup_trigger_plan = partial(
+            setup_zebra_for_gridscan,
+        )
         tidy_plan = partial(
             tidy_up_zebra_after_gridscan,
             xrc_composite.zebra,

mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py

@@ -34,6 +34,10 @@ from mx_bluesky.common.device_setup_plans.manipulate_sample import (
     cleanup_sample_environment,
     setup_sample_environment,
 )
+from mx_bluesky.common.device_setup_plans.setup_zebra_and_shutter import (
+    setup_zebra_for_rotation,
+    tidy_up_zebra_after_rotation_scan,
+)
 from mx_bluesky.common.device_setup_plans.utils import (
     start_preparing_data_collection_then_do_plan,
 )
@@ -55,8 +59,6 @@ from mx_bluesky.common.utils.context import device_composite_from_context
 from mx_bluesky.common.utils.log import LOGGER
 from mx_bluesky.hyperion.device_setup_plans.setup_zebra import (
     arm_zebra,
-    setup_zebra_for_rotation,
-    tidy_up_zebra_after_rotation_scan,
 )
 from mx_bluesky.hyperion.parameters.constants import CONST, I03Constants
 from mx_bluesky.hyperion.parameters.rotation import (

mx_bluesky/hyperion/external_interaction/callbacks/alert_on_container_change.py

@@ -1,5 +1,5 @@
 from dodal.utils import get_beamline_name
-from event_model import Event, EventDescriptor, RunStart
+from event_model import Event, EventDescriptor, RunStart, RunStop
 
 from mx_bluesky.common.external_interaction.alerting import (
     Metadata,
@@ -48,7 +48,16 @@ class AlertOnContainerChange(PlanReactiveCallback):
         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")
+        if not self._sample_id:
+            ISPYB_ZOCALO_CALLBACK_LOGGER.info("Capturing container info for alerts")
+            metadata = doc.get("metadata", {})
+            self._new_container = metadata.get("container")
+            self._sample_id = metadata.get("sample_id")
+            self._visit = metadata.get("visit")
+
+    def activity_gated_stop(self, doc: RunStop):
+        if not self.active:
+            ISPYB_ZOCALO_CALLBACK_LOGGER.info("Resetting state")
+            self._new_container = None
+            self._sample_id = None
+            self._visit = None

{mx_bluesky-1.5.8.dist-info → mx_bluesky-1.5.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.8
+Version: 1.5.9
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -241,7 +241,7 @@ Requires-Dist: blueapi>=0.15.0
 Requires-Dist: ophyd>=1.10.5
 Requires-Dist: ophyd-async>=0.10.0a2
 Requires-Dist: bluesky>=1.13.1
-Requires-Dist: dls-dodal==1.61.0
+Requires-Dist: dls-dodal==1.62.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"

{mx_bluesky-1.5.8.dist-info → mx_bluesky-1.5.9.dist-info}/RECORD

@@ -1,6 +1,6 @@
 mx_bluesky/__init__.py,sha256=Ksms_WJF8LTkbm38gEpm1jBpGqcQ8NGvmb2ZJlOE1j8,198
 mx_bluesky/__main__.py,sha256=RVqPnxDisFMIn_aoEi0drlThNHgKTJULnSrotouIKI0,480
-mx_bluesky/_version.py,sha256=QlBPCHWJHsKOjOT6a1pMTyQvJ4_hi1jBIVqdqRIdaR0,704
+mx_bluesky/_version.py,sha256=R8NtNnDKq3ku-8r0RS1XECjtWqIXXUTnvgF1AljQn-k,704
 mx_bluesky/definitions.py,sha256=ULpEYAUzdQiEbBoTgYTMxfUf3DDDjhYtvDxofs7Qxqw,168
 mx_bluesky/jupyter_example.ipynb,sha256=wpwvPrBvwtRMS5AIFk8F54cIlUoD0o4ji8tKK5cZHA4,1672
 mx_bluesky/beamlines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -13,12 +13,14 @@ mx_bluesky/beamlines/i02_1/parameters/gridscan.py,sha256=P-WBnYSKcFQxMyeziIlWPht
 mx_bluesky/beamlines/i04/__init__.py,sha256=DM5-pkoPb2jill-VmKdhEylsV1jryA92gygCIFSv3Fo,383
 mx_bluesky/beamlines/i04/redis_to_murko_forwarder.py,sha256=LViC4Dql47EXIDnI2hkt9CMtIyF1_e8h0s4GyIAllmA,6656
 mx_bluesky/beamlines/i04/thawing_plan.py,sha256=eSqX3VKHKw_KDGxjpszDifRpdb_RkwQxMKAZlOgl_7c,9759
+mx_bluesky/beamlines/i04/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/beamlines/i04/callbacks/murko_callback.py,sha256=C2KoIxwMIWxD46utmq1-69SIc8MspocXJ1sccO1lwAY,4458
 mx_bluesky/beamlines/i04/experiment_plans/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mx_bluesky/beamlines/i04/experiment_plans/i04_grid_detect_then_xray_centre_plan.py,sha256=NYbJfC8sksF-H8m1fCmQTWHBLQKzzpIqBJVjihYp4ew,9232
+mx_bluesky/beamlines/i04/experiment_plans/i04_grid_detect_then_xray_centre_plan.py,sha256=3Nv3EFNS5k5ivMMo15aR9br7mfz9WQ0S9_Olphe9D4Y,10168
 mx_bluesky/beamlines/i23/__init__.py,sha256=7nwQiKBZAXLnvPhCqaI2VC1k4TOzQalOUvwF6SQ3Yd4,95
 mx_bluesky/beamlines/i23/serial.py,sha256=XVbHM8NevnJMFAJD9jkxG-VnPaWX6t_k-wlipRw0pmY,2055
 mx_bluesky/beamlines/i24/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mx_bluesky/beamlines/i24/jungfrau_commissioning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/beamlines/i24/jungfrau_commissioning/do_external_acquisition.py,sha256=p5ZOhM3COwiBjolMzHs8HNZGbTiIBjys4iUNQtUMKI0,1573
 mx_bluesky/beamlines/i24/jungfrau_commissioning/do_internal_acquisition.py,sha256=cNj4z3TFv8UgtDJax-v8Di74-gKLsTVKtwbCya-wwcw,1744
 mx_bluesky/beamlines/i24/jungfrau_commissioning/plan_utils.py,sha256=IaOw0pX8os-14EoLTwGTrFsl4PUZdL0ymbvdS7lhTto,2789
@@ -75,21 +77,23 @@ mx_bluesky/beamlines/i24/serial/web_gui_plans/__init__.py,sha256=47DEQpj8HBSa-_T
 mx_bluesky/beamlines/i24/serial/web_gui_plans/general_plans.py,sha256=4Cn7B-ZaNdcBkpsBg3BNLaNW5YZ-YkTSiJ4iJV-k4Y8,8471
 mx_bluesky/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/common/xrc_result.py,sha256=tUJ6qkDTTB6H1F71IvVAKtmHCRyHSU_tj9GRzVmnE7w,3219
-mx_bluesky/common/device_setup_plans/manipulate_sample.py,sha256=bM4D0ezAqCJqclN5-hIVUoN_X55F8Yiv_ap6_ChKCA0,3091
+mx_bluesky/common/device_setup_plans/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mx_bluesky/common/device_setup_plans/manipulate_sample.py,sha256=bKVWiXQnibXEjKjCNvy9PX4kUSh1CsBQCkqO5tUgrOU,3130
 mx_bluesky/common/device_setup_plans/position_detector.py,sha256=S49ml0KNZ6wXPQqOxNJ2whKTCyRTcKdBXBhyeEyFDQQ,635
-mx_bluesky/common/device_setup_plans/robot_load_unload.py,sha256=k3JSKBznJQWfYTlM6QO26BmpK5D3w4GJkvcJHLlujIw,4416
+mx_bluesky/common/device_setup_plans/robot_load_unload.py,sha256=_pUrKEm34qSVdaUM83ypu3i2bAOdYqRLPU1ONhPowD4,4493
 mx_bluesky/common/device_setup_plans/setup_oav.py,sha256=7WLElZZU5mWq9g2WP86p3P81uiSPuj2V4kIkqXlap3o,2692
 mx_bluesky/common/device_setup_plans/setup_panda.py,sha256=OF-ZygZyAyQEUdrAWiIxWZ6QhAsVx4Mm9ngRYB1mzKI,433
+mx_bluesky/common/device_setup_plans/setup_zebra_and_shutter.py,sha256=y83Szce7QxXdpLeGXpgyhceOr1HCE6fs6zmZr77IYAE,10066
 mx_bluesky/common/device_setup_plans/utils.py,sha256=S_Us1KfLkyaRzWxmqnoVxHj2Suq-Vs0n5fMRygHgrTw,1859
 mx_bluesky/common/device_setup_plans/xbpm_feedback.py,sha256=WsUMdeOZBgbj-bFp7x66aHp2oWffQmjyp61-qmtQAmI,2153
 mx_bluesky/common/experiment_plans/__init__.py,sha256=FMA-4VN1TJCPcyURKF0qPIQ8uo8YBbtHPRdJokVF4MA,129
 mx_bluesky/common/experiment_plans/change_aperture_then_move_plan.py,sha256=407E9rp0yGWWIU1fJrgqK_hC19mVwRK-Und7fMlGNDc,3062
-mx_bluesky/common/experiment_plans/common_flyscan_xray_centre_plan.py,sha256=wf22Xwx79UXg_kKG8cD9IeIP_4gY0-p2aNhrUn37eFI,14213
+mx_bluesky/common/experiment_plans/common_flyscan_xray_centre_plan.py,sha256=JIRgSYqhgGu3I8lY3Oq2cyFNjcf_duRuWf0bhMgtOiU,13613
 mx_bluesky/common/experiment_plans/common_grid_detect_then_xray_centre_plan.py,sha256=jspOKPc3uxvG-a5-LXs7Yfwy8HTvGXBj4snke9j5gYE,7033
 mx_bluesky/common/experiment_plans/oav_grid_detection_plan.py,sha256=gkRpRb3USUx7xDJk-1GghV-sxPp7wy5clubwhlx1v80,7162
 mx_bluesky/common/experiment_plans/oav_snapshot_plan.py,sha256=8TRAvHG2W9bn1xb06bYZTWkfhT2q1EtfyxyiMMKmWcw,3623
-mx_bluesky/common/experiment_plans/inner_plans/__init__ .py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mx_bluesky/common/experiment_plans/inner_plans/do_fgs.py,sha256=J8SF-ejb9PpB_wpL1QuS7_FIB5YxDN70odokc5dSIXY,4717
+mx_bluesky/common/experiment_plans/inner_plans/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mx_bluesky/common/experiment_plans/inner_plans/do_fgs.py,sha256=8Umn101RqCbtSKuw6duHKShPG2Cu3gYi_Cc51d29g7U,4865
 mx_bluesky/common/experiment_plans/inner_plans/read_hardware.py,sha256=Og7Uz8lAB1_Z6puN6ws_2kwOqCvgQMqfmyZPFZMRneY,2351
 mx_bluesky/common/experiment_plans/inner_plans/udc_default_state.py,sha256=TnO5hv1I_UWlB1Vz7dCQ-nGj4LLsu9nQgetaK6hc_YM,2704
 mx_bluesky/common/experiment_plans/inner_plans/write_sample_status.py,sha256=pmS4Lsndp90CCIKzD_wssvbzt1qu7rEzfXgxvDwDrQ8,1313
@@ -102,7 +106,7 @@ mx_bluesky/common/external_interaction/callbacks/common/__init__.py,sha256=47DEQ
 mx_bluesky/common/external_interaction/callbacks/common/abstract_event.py,sha256=iBj4WNK5ikieZzTePBZ9AEu6ehlnpew1nDK3ONJqibI,2093
 mx_bluesky/common/external_interaction/callbacks/common/grid_detection_callback.py,sha256=hfFJjICMer26TowK5Nq-AEjDe1TAHIgJAvTFhs-o-Zg,4901
 mx_bluesky/common/external_interaction/callbacks/common/ispyb_callback_base.py,sha256=--eZl4flvtrKZQz5ZhLO87Z1kDboQevIkujrXCADZEI,9869
-mx_bluesky/common/external_interaction/callbacks/common/ispyb_mapping.py,sha256=bHtnDZfxIR5zzSRiBSehZ51y42wzkEcCJ7rFg93aONA,2578
+mx_bluesky/common/external_interaction/callbacks/common/ispyb_mapping.py,sha256=pzDlNEGhXACc5MyO_FAT2PlCYz6r_bnz_S08hXEGjdk,2707
 mx_bluesky/common/external_interaction/callbacks/common/log_uid_tag_callback.py,sha256=pfZxQfS9SnXep3F2YAPptDX5bjjWvbXtgy5fINfsoTU,626
 mx_bluesky/common/external_interaction/callbacks/common/logging_callback.py,sha256=NHb8Gp86TAk6PRTV3inWrlW-Lj96LmnZda7ZGewlrFA,712
 mx_bluesky/common/external_interaction/callbacks/common/plan_reactive_callback.py,sha256=567fx-ONKTZ7V5y5dk0YthxxDJt0s6dZtqrYA0AkfAk,4088
@@ -110,7 +114,7 @@ mx_bluesky/common/external_interaction/callbacks/common/zocalo_callback.py,sha25
 mx_bluesky/common/external_interaction/callbacks/sample_handling/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/common/external_interaction/callbacks/sample_handling/sample_handling_callback.py,sha256=BfUru03fRYmndjiWHpnqBIWPc5kRIy4PTmG94bz3gLw,3886
 mx_bluesky/common/external_interaction/callbacks/xray_centre/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mx_bluesky/common/external_interaction/callbacks/xray_centre/ispyb_callback.py,sha256=ezC3bbz84NLSPswHeUNVZr1eJEt_X6aPr7sn-IxdI9I,14879
+mx_bluesky/common/external_interaction/callbacks/xray_centre/ispyb_callback.py,sha256=fwPPwOvy1yGC8D5KOlpZitBWtVNzfNjK2yz-ZTT6q9Q,15398
 mx_bluesky/common/external_interaction/callbacks/xray_centre/ispyb_mapping.py,sha256=yElqODhPm2HZlpF7vNOX0SQNjwJ_m8kNMS-c_cp4KUU,1163
 mx_bluesky/common/external_interaction/callbacks/xray_centre/nexus_callback.py,sha256=bxFMkTsMvZZJyp4zeGlZkThgZnQqT6dgflKRpqkT1Vc,4709
 mx_bluesky/common/external_interaction/ispyb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -145,12 +149,12 @@ mx_bluesky/hyperion/runner.py,sha256=x683wuzL-XO1Ws4N2fpPO__TLhlep0br_-8ubml1qG0
 mx_bluesky/hyperion/device_setup_plans/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/hyperion/device_setup_plans/dcm_pitch_roll_mirror_adjuster.py,sha256=ciNdz_r9XGvghehpejdziL-aMw60oUsIJdVR3yz3nOo,5010
 mx_bluesky/hyperion/device_setup_plans/setup_panda.py,sha256=96eFp4acQLOthe1PA-S14uv635uGVP71DpP7qy_uo40,8509
-mx_bluesky/hyperion/device_setup_plans/setup_zebra.py,sha256=e3ocVsncImQIrfL6d0UoH5fCl8AR0pM_4AIXSxc8dgQ,5749
+mx_bluesky/hyperion/device_setup_plans/setup_zebra.py,sha256=dOfBQMibyH3CjSh_m5RJKsxs2DtaM3jtwEs7lkqQppo,1525
 mx_bluesky/hyperion/device_setup_plans/smargon.py,sha256=eb3TCXg33SW6TlfElh5KjYwCXhELDprj0B27CwYcd9c,967
 mx_bluesky/hyperion/device_setup_plans/utils.py,sha256=96JlzyikMhWN7LzdiMx8URZInXoGR3OjoxYmCIp9tts,425
 mx_bluesky/hyperion/experiment_plans/__init__.py,sha256=dJjwLk0EQP-1hKhbs8aRxTF_LxUXgB7kcgDlaP-tMnk,787
 mx_bluesky/hyperion/experiment_plans/experiment_registry.py,sha256=bGp2c3nKutqHMnDxuqjp6yCF-JKykSzX-IUfxk3oVlM,1701
-mx_bluesky/hyperion/experiment_plans/hyperion_flyscan_xray_centre_plan.py,sha256=aaDnO_fWOesB7IUMtedinBaJUdliWZe47wxq9ECFoFY,6036
+mx_bluesky/hyperion/experiment_plans/hyperion_flyscan_xray_centre_plan.py,sha256=qYDI39ic1kOfy8GL9_744kjuEzwPUBji65okxbOpWEE,6074
 mx_bluesky/hyperion/experiment_plans/hyperion_grid_detect_then_xray_centre_plan.py,sha256=e4w4226ONSGQF2dnXzxOfcJ9i57CZIJrqQ1YCLlaBNo,2153
 mx_bluesky/hyperion/experiment_plans/load_centre_collect_full_plan.py,sha256=obUMizdLRGt-uCLnEzwiCGHn8wqHt0OVo1uvVvivWr4,7675
 mx_bluesky/hyperion/experiment_plans/optimise_attenuation_plan.py,sha256=5ZAH17F5T1YyVgA2ML0NEf4ufrD1G0jPRU0_5pINdTg,16195
@@ -158,7 +162,7 @@ mx_bluesky/hyperion/experiment_plans/pin_centre_then_xray_centre_plan.py,sha256=
 mx_bluesky/hyperion/experiment_plans/pin_tip_centring_plan.py,sha256=1g3vs2hSgEYGhwDoqB8VsWTZ4q_Hd37493n_csoLnI8,6248
 mx_bluesky/hyperion/experiment_plans/robot_load_and_change_energy.py,sha256=bqG4enP2bZQ6ND0c5XqwDySQTkQRBdK7gvWf61VEnWM,6051
 mx_bluesky/hyperion/experiment_plans/robot_load_then_centre_plan.py,sha256=samWAztWJU9sRo1FtIicWWQZ7TjUwg7Y9y9oqhkcb5o,6904
-mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py,sha256=jyJMN9atG99hmYG0i3lgrBK9Jx1SR4QVPFhZgA6Dl8s,15886
+mx_bluesky/hyperion/experiment_plans/rotation_scan_plan.py,sha256=oFZ3HoWfgVRnuz2crTzSPUvdM2l7wz7RPbygUcTeo0Q,15963
 mx_bluesky/hyperion/experiment_plans/set_energy_plan.py,sha256=8FAqN-aJgRwZSiCX-hNdeGmaijt0l8owdShVBwNchfE,2643
 mx_bluesky/hyperion/external_interaction/__init__.py,sha256=95DwXDmKsx36RgAL-AtLZl2LQoLPKbzeYdlkkP_4Coc,559
 mx_bluesky/hyperion/external_interaction/agamemnon.py,sha256=B2Q7NR1VSRoCGg4hlCiZDrh2Fa0s4B4ZIws1H7oBfOk,12020
@@ -167,8 +171,9 @@ mx_bluesky/hyperion/external_interaction/alerting/__init__.py,sha256=47DEQpj8HBS
 mx_bluesky/hyperion/external_interaction/alerting/constants.py,sha256=8wE_MDF8vOqomQ6SBiwZKb1W4NRO_hmrBLVfLVnKdSg,170
 mx_bluesky/hyperion/external_interaction/callbacks/__init__.py,sha256=1XHaxDljMveu_DYIlk7n963gHffyC6r4C_RhF6HA-N8,283
 mx_bluesky/hyperion/external_interaction/callbacks/__main__.py,sha256=6-CqBh3uIi-mu_eWSJQ0hBQhoQaC7m8mSi8cHmyrjK0,6827
-mx_bluesky/hyperion/external_interaction/callbacks/alert_on_container_change.py,sha256=QnA8P8QFDRr1XHyx6Qdd4uJal2GhQVcqSTbkLOEjw-Q,2299
+mx_bluesky/hyperion/external_interaction/callbacks/alert_on_container_change.py,sha256=54RU20RuwKHYwB6DtAc0aWg6hz3TXFhwDzTmSC2XYVE,2689
 mx_bluesky/hyperion/external_interaction/callbacks/snapshot_callback.py,sha256=ee1ZIJGp8RQakMDYRfflXjSwi-UgxqdZNkZ1azBIDGQ,11705
+mx_bluesky/hyperion/external_interaction/callbacks/robot_actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/hyperion/external_interaction/callbacks/robot_actions/ispyb_callback.py,sha256=Ta8w0W_3LI0PGpwxKlQsS7X0B_hsfJoZdzR2K3J0KHo,4467
 mx_bluesky/hyperion/external_interaction/callbacks/rotation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mx_bluesky/hyperion/external_interaction/callbacks/rotation/ispyb_callback.py,sha256=4XW5eTwlPKGLk3MS76QRu5U6DOYAQHBEUBKqaNDnVhs,8885
@@ -188,10 +193,9 @@ mx_bluesky/hyperion/utils/__init__.py,sha256=f4E8wInL1Ll4eeFtAiyKmipOBTPlUtKmVK-
 mx_bluesky/hyperion/utils/context.py,sha256=yxMYn3YFET6SanFZ4YWXDmZDdp3WkaXhDc3ySxHYpAE,1033
 mx_bluesky/phase1_zebra/__init__.py,sha256=Edhhn2L9MVXnjJhyD5_yKQVUDo7XW98rvuT7dlzIn58,132
 mx_bluesky/phase1_zebra/device_setup_plans/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mx_bluesky/phase1_zebra/device_setup_plans/setup_zebra.py,sha256=zfEnDvh5Rh9cPmg_Q_0EnJOZNIwIGmHeIDiJ9kg9Z4c,4129
-mx_bluesky-1.5.8.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-mx_bluesky-1.5.8.dist-info/METADATA,sha256=Sgd23MlRNkDX8FybwhVs0WYSqmA7Elx1hCMuSps2fJw,17424
-mx_bluesky-1.5.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mx_bluesky-1.5.8.dist-info/entry_points.txt,sha256=HgVtwgWoMRn9-X6rxCcSY3Jz_paspJTIlc-t2NFzWpo,409
-mx_bluesky-1.5.8.dist-info/top_level.txt,sha256=S4rrzXIUef58ulf_04wn01XGZ3xeJjXs4LPEJ_xoF-I,11
-mx_bluesky-1.5.8.dist-info/RECORD,,
+mx_bluesky-1.5.9.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+mx_bluesky-1.5.9.dist-info/METADATA,sha256=cLEcoIhuVwQrVcBG0-AWiw3LdWaXVDPX4WE9dTtOPXU,17424
+mx_bluesky-1.5.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mx_bluesky-1.5.9.dist-info/entry_points.txt,sha256=HgVtwgWoMRn9-X6rxCcSY3Jz_paspJTIlc-t2NFzWpo,409
+mx_bluesky-1.5.9.dist-info/top_level.txt,sha256=S4rrzXIUef58ulf_04wn01XGZ3xeJjXs4LPEJ_xoF-I,11
+mx_bluesky-1.5.9.dist-info/RECORD,,

mx_bluesky/phase1_zebra/device_setup_plans/setup_zebra.py

@@ -1,112 +0,0 @@
-from typing import Protocol, runtime_checkable
-
-import bluesky.plan_stubs as bps
-from bluesky.utils import MsgGenerator
-from dodal.devices.zebra.zebra import (
-    Zebra,
-)
-from dodal.devices.zebra.zebra_controlled_shutter import (
-    ZebraShutter,
-    ZebraShutterControl,
-)
-
-from mx_bluesky.common.parameters.constants import ZEBRA_STATUS_TIMEOUT
-from mx_bluesky.common.utils.log import LOGGER
-
-
-@runtime_checkable
-class GridscanSetupDevices(Protocol):
-    zebra: Zebra
-    sample_shutter: ZebraShutter
-
-
-def setup_zebra_for_gridscan(
-    composite: GridscanSetupDevices,  # XRC gridscan's generic trigger setup expects a composite rather than individual devices
-    group="setup_zebra_for_gridscan",
-    wait=True,
-) -> MsgGenerator:
-    zebra = composite.zebra
-    # Set shutter to automatic and to trigger via motion controller GPIO signal (IN4_TTL)
-    yield from configure_zebra_and_shutter_for_auto_shutter(
-        zebra, composite.sample_shutter, zebra.mapping.sources.IN4_TTL, group=group
-    )
-
-    yield from bps.abs_set(
-        zebra.output.out_pvs[zebra.mapping.outputs.TTL_DETECTOR],
-        zebra.mapping.sources.IN3_TTL,
-        group=group,
-    )
-    yield from bps.abs_set(
-        zebra.output.out_pvs[zebra.mapping.outputs.TTL_XSPRESS3],
-        zebra.mapping.sources.DISCONNECT,
-        group=group,
-    )
-    yield from bps.abs_set(
-        zebra.output.pulse_1.input, zebra.mapping.sources.DISCONNECT, group=group
-    )
-
-    if wait:
-        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)
-
-
-def set_shutter_auto_input(zebra: Zebra, input: int, group="set_shutter_trigger"):
-    """Set the signal that controls the shutter. We use the second input to the
-    Zebra's AND2 gate for this input. ZebraShutter control mode must be in auto for this input to take control
-
-    For more details see the ZebraShutter device."""
-    auto_gate = zebra.mapping.AND_GATE_FOR_AUTO_SHUTTER
-    auto_shutter_control = zebra.logic_gates.and_gates[auto_gate]
-    yield from bps.abs_set(auto_shutter_control.sources[2], input, group)
-
-
-def configure_zebra_and_shutter_for_auto_shutter(
-    zebra: Zebra, zebra_shutter: ZebraShutter, input: int, group="use_automatic_shutter"
-):
-    """Set the shutter to auto mode, and configure the zebra to trigger the shutter on
-    an input source. For the input, use one of the source constants in zebra.py
-
-    When the shutter is in auto/manual, logic in EPICS sets the Zebra's
-    SOFT_IN1 to low/high respectively. The Zebra's AND2 gate should be used to control the shutter while in auto mode.
-    To do this, we need (AND2 = SOFT_IN1 AND input), where input is the zebra signal we want to control the shutter when in auto mode.
-    """
-    # See https://github.com/DiamondLightSource/dodal/issues/813 for better typing here.
-
-    # Set shutter to auto mode
-    yield from bps.abs_set(
-        zebra_shutter.control_mode, ZebraShutterControl.AUTO, group=group
-    )
-
-    auto_gate = zebra.mapping.AND_GATE_FOR_AUTO_SHUTTER
-
-    # Set first input of AND2 gate to SOFT_IN1, which is high when shutter is in auto mode
-    # Note the Zebra should ALWAYS be setup this way. See https://github.com/DiamondLightSource/mx-bluesky/issues/551
-    yield from bps.abs_set(
-        zebra.logic_gates.and_gates[auto_gate].sources[1],
-        zebra.mapping.sources.SOFT_IN1,
-        group=group,
-    )
-
-    # Set the second input of AND2 gate to the requested zebra input source
-    yield from set_shutter_auto_input(zebra, input, group=group)
-
-
-def tidy_up_zebra_after_gridscan(
-    zebra: Zebra,
-    zebra_shutter: ZebraShutter,
-    group="tidy_up_zebra_after_gridscan",
-    wait=True,
-) -> MsgGenerator:
-    LOGGER.info("Tidying up Zebra")
-
-    yield from bps.abs_set(
-        zebra.output.out_pvs[zebra.mapping.outputs.TTL_DETECTOR],
-        zebra.mapping.sources.PC_PULSE,
-        group=group,
-    )
-    yield from bps.abs_set(
-        zebra_shutter.control_mode, ZebraShutterControl.MANUAL, group=group
-    )
-    yield from set_shutter_auto_input(zebra, zebra.mapping.sources.PC_GATE, group=group)
-
-    if wait:
-        yield from bps.wait(group, timeout=ZEBRA_STATUS_TIMEOUT)