mx-bluesky 1.4.9__tar.gz → 1.5.0__tar.gz

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/.github/workflows/_container.yml

@@ -30,14 +30,25 @@ jobs:
           DOCKER_BUILD_RECORD_UPLOAD: false
         with:
           context: .
-          file: Dockerfile.release
+          file: Dockerfile.hyperion
+          load: true
+
+      - name: Build and export Dockerfile.blueapi to local cache
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          file: Dockerfile.blueapi
           load: true
 
       - name: Create tags for publishing image
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ghcr.io/${{ github.repository }}
+          images: |
+            ghcr.io/${{ github.repository }}
+            ghcr.io/${{ github.repository }}-blueapi
           tags: |
             type=ref,event=tag
             type=raw,value=latest
@@ -51,7 +62,19 @@ jobs:
         # Docker cache and publish it
         with:
           context: .
-          file: Dockerfile.release
+          file: Dockerfile.hyperion
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Push Dockerfile.blueapi image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          file: Dockerfile.blueapi
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

mx_bluesky-1.5.0/Dockerfile.blueapi

@@ -0,0 +1,14 @@
+ # See https://github.com/DiamondLightSource/mx-bluesky/issues/1004
+FROM ghcr.io/diamondlightsource/blueapi:0.10.1
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+RUN apt update -y && apt upgrade -y
+# Needed for python cv2 dependency
+RUN apt install -y libgl1 libglib2.0-0
+
+RUN /venv/bin/pip install mx-bluesky
+
+# Needed so that Blueapi's setup-scratch stage has permission to modify dependencies installed 
+# in the above pip installation
+RUN mkdir -p /.cache/pip; chmod -R 777 /venv /.cache/pip

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.4.9
+Version: 1.5.0
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -234,12 +234,12 @@ Requires-Dist: scanspec
 Requires-Dist: scipy
 Requires-Dist: semver
 Requires-Dist: matplotlib
-Requires-Dist: blueapi>=0.5.0
+Requires-Dist: blueapi>=0.11.1
 Requires-Dist: daq-config-server==0.1.1
 Requires-Dist: ophyd>=1.10.5
 Requires-Dist: ophyd-async>=0.10.0a2
 Requires-Dist: bluesky>=1.13.1
-Requires-Dist: dls-dodal==1.48.0
+Requires-Dist: dls-dodal==1.49.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/docs/developer/code-map/grid_detect_xrc.rst

@@ -1,9 +1,9 @@
 Grid Detect Then Xray Centre
 ============================
 
-The aim of this page is to provide a general overview of the Hyperion ``grid_detect_then_xray_centre_plan``.
+The aim of this page is to provide a general overview of the ``grid_detect_then_xray_centre_plan``.
 
-Most of the code for the ``grid_detect_then_xray_centre_plan`` plan is in ``mx-bluesky/hyperion``. Some code is located in ``mx-bluesky/common`` and `dodal <https://github.com/DiamondLightSource/dodal>`_, and plans are increasingly being generalised and moved into ``mx-bluesky/common`` where possible. Therefore, the structure of the codebase is subject to change and this document should be updated accordingly.
+The code for the ``grid_detect_then_xray_centre`` plan is now entirely ``mx-bluesky/common/`` and `dodal <https://github.com/DiamondLightSource/dodal>`_. There is a new Hyperion entry point, ``hyperion_grid_detect_then_xray_centre`` which calls this common plan, setting up Hyperion features for it. There will soon be an i04 entry point that calls the common plan in the same way.
 
 There are then a number of plans that make up the ``grid_detect_then_xray_centre_plan`` plan. Some important ones:
 
@@ -11,7 +11,7 @@ There are then a number of plans that make up the ``grid_detect_then_xray_centre
 * :ref:`flyscan_xray_centre_plan<flyscan>` - Triggers a hardware-based grid scan and moves to the X-ray centre as returned from ``zocalo``.
 * :ref:`grid_detect_then_xray_centre_plan<grid-detect-xrc>` - This top-level plan performs an :ref:`OAV grid detection <grid-detect>` then a :ref:`flyscan x-ray centre <flyscan>`.
 
-The diagram below shows all the plans that make up the ``grid_detect_then_xray_centre_plan``. The colors indicate where these plans can be found.
+The diagram below shows all the plans that make up the ``grid_detect_then_xray_centre_plan``.
 
 .. image:: grid_detect_then_xray_centre.drawio.png
 
@@ -20,21 +20,22 @@ The diagram below shows all the plans that make up the ``grid_detect_then_xray_c
 Grid Detect Then Xray Centre Plan
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/hyperion/experiment_plans/grid_detect_then_xray_centre_plan.py>`__ does the following, in roughly this order:
+`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/common/experiment_plans/common_grid_detect_then_xray_centre_plan.py>`__ does the following, in roughly this order:
 
 1. If called standalone, start preparing for data collection.
-2. Perform an :ref:`OAV grid detection <grid-detect>`.
-3. Convert the parameters calculated in step 2 into something we can send to the flyscan X-ray centre.
-4. Move the backlight out, set the aperture to small, and wait for the detector to finish moving.
-5. Perform a :ref:`flyscan X-ray centre <flyscan>`.
-6. Move the sample based on the results of step 5.
+2. Move the beamstop into place if it isn't already.
+3. Perform an :ref:`OAV grid detection <grid-detect>`.
+4. Convert the parameters calculated in step 2 into something we can send to the flyscan X-ray centre.
+5. Move the backlight out, set the aperture to small, and wait for the detector to finish moving.
+6. Perform a :ref:`flyscan X-ray centre <flyscan>`.
+7. Move the sample based on the results of step 5.
 
 .. _grid-detect:
 
 OAV Grid Detection
 ~~~~~~~~~~~~~~~~~~
 
-`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/hyperion/experiment_plans/oav_grid_detection_plan.py>`__ does the following, in roughly this order:
+`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/common/experiment_plans/oav_grid_detection_plan.py>`__ does the following, in roughly this order:
 
 1. Move to omega 0.
 2. Calculate the 2D grid size using the edge arrays from the OAV.
@@ -48,7 +49,7 @@ OAV Grid Detection
 Flyscan Xray Centre No Move
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/hyperion/experiment_plans/flyscan_xray_centre_plan.py>`__ does the following, in roughly this order:
+`This plan <https://github.com/DiamondLightSource/mx-bluesky/blob/main/src/mx_bluesky/common/experiment_plans/common_flyscan_xray_centre_plan.py>`__ does the following, in roughly this order:
 
 1. Move to the desired transmission (and turn off xbpm feedback).
 2. Move to omega 0.

mx_bluesky-1.5.0/docs/developer/general/explanations/containerised_mx_bluesky.rst

@@ -0,0 +1,14 @@
+Containerised mx-bluesky
+========================
+
+There are currently two images associated with this repository which are pushed on release: hyperion, and mx-bluesky-blueapi.
+
+The Hyperion image exists because Hyperion was developed before BlueAPI was production-ready, and so doesn't use BlueAPI to schedule plans. This image is only really relevant for i03, and currently isn't used in production anywhere
+
+The ``mx-bluesky-blueapi`` image exists as a minor extension of BlueAPI's image. BlueAPI's image contains the dependencies of BlueAPI, as well as the dependencies of BlueAPI, which includes dodal. When the BlueAPI service is launched, it will do a ``pip install --no deps`` of the plan repository. For MX, this means ``mx-bluesky`` gets installed without any of its dependencies. For this reason, we have created an ``mx-bluesky-blueapi`` image which installs these extra dependencies. 
+
+This image can be used with BlueAPI's original helmchart, the only change required in the ``values.yaml`` is::
+
+    image:
+        repository: ghcr.io/diamondlightsource/mx-bluesky-blueapi
+        tag: "{desired_version}"

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/docs/developer/general/how-to/create-a-release.rst

@@ -17,6 +17,8 @@ Release
 6. You should now manually go through each line on the release notes and read it from the perspective of a beamline scientist. It should be clear from each what the change means to the beamline and should have links to easily find further info.
 7. Publish the release
 
+NOTE FOR USING THE MX-BLUESKY-BLUEAPI IMAGE: If using this image with BlueAPI's helmchart for deployment, the version of dodal which is installed will be the version which is pinned in the BlueAPI, rather than what's in mx-bluesky's pyproject.toml. Before releasing, you should pin BlueAPI to a version which uses a dodal version which is compatible with itself AND mx-bluesky. The deployment will fail if BlueAPI has no version which works with the desired dodal version
+
 ------------------------
 Deciding release numbers
 ------------------------

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/docs/developer/general/index.rst

@@ -42,6 +42,7 @@ Documentation is split into four categories, and each is also accessible from li
 
             explanations/decisions
             explanations/callback_and_run_logic
+            explanations/containerised_mx_bluesky
 
         +++
 

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/pyproject.toml

@@ -41,12 +41,12 @@ dependencies = [
     # These dependencies may be issued as pre-release versions and should have a pin constraint
     # as by default pip-install will not upgrade to a pre-release.
     #
-    "blueapi >= 0.5.0",
+    "blueapi >= 0.11.1",
     "daq-config-server == 0.1.1",
     "ophyd >= 1.10.5",
     "ophyd-async >= 0.10.0a2",
     "bluesky >= 1.13.1",
-    "dls-dodal == 1.48.0"
+    "dls-dodal == 1.49.0",
 ]
 
 

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.4.9'
-__version_tuple__ = version_tuple = (1, 4, 9)
+__version__ = version = '1.5.0'
+__version_tuple__ = version_tuple = (1, 5, 0)

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/beamlines/i24/serial/__init__.py

@@ -2,7 +2,8 @@ from mx_bluesky.beamlines.i24.serial.web_gui_plans.general_plans import (
     gui_gonio_move_on_click,
     gui_move_backlight,
     gui_move_detector,
-    gui_set_parameters,
+    gui_run_chip_collection,
+    gui_set_zoom_level,
     gui_sleep,
     gui_stage_move_on_click,
 )
@@ -57,6 +58,7 @@ __all__ = [
     "gui_gonio_move_on_click",
     "gui_sleep",
     "gui_move_detector",
-    "gui_set_parameters",
+    "gui_run_chip_collection",
     "gui_move_backlight",
+    "gui_set_zoom_level",
 ]

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/beamlines/i24/serial/blueapi_config.yaml

@@ -8,6 +8,10 @@ env:
     broadcast_status_events: false
 api:
   port: 25565
+  cors:
+    allow_credentials: True
+    origins: 
+      - "*"
 stomp:
   enabled: true
   host: i24-control.diamond.ac.uk

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/beamlines/i24/serial/fixed_target/i24ssx_Chip_Collect_py3v1.py

@@ -684,6 +684,38 @@ def run_fixed_target_plan(
     # DCID instance - do not create yet
     dcid = DCID(emit_errors=False, expt_params=parameters)
 
+    yield from run_plan_in_wrapper(
+        zebra,
+        pmac,
+        aperture,
+        backlight,
+        beamstop,
+        detector_stage,
+        shutter,
+        dcm,
+        mirrors,
+        beam_center_device,
+        parameters,
+        dcid,
+        pilatus_metadata,
+    )
+
+
+def run_plan_in_wrapper(
+    zebra: Zebra,
+    pmac: PMAC,
+    aperture: Aperture,
+    backlight: DualBacklight,
+    beamstop: Beamstop,
+    detector_stage: DetectorMotion,
+    shutter: HutchShutter,
+    dcm: DCM,
+    mirrors: FocusMirrorsMode,
+    beam_center_device: DetectorBeamCenter,
+    parameters: FixedTargetParameters,
+    dcid: DCID,
+    pilatus_metadata: PilatusMetadata,
+) -> MsgGenerator:
     yield from bpp.contingency_wrapper(
         main_fixed_target_plan(
             zebra,

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/beamlines/i24/serial/fixed_target/i24ssx_Chip_Manager_py3v1.py

@@ -256,6 +256,7 @@ def upload_chip_map_to_geobrick(pmac: PMAC, chip_map: list[int]) -> MsgGenerator
     """
     SSX_LOGGER.info("Uploading Parameters for Oxford Chip to the GeoBrick")
     SSX_LOGGER.info(f"Chipid {ChipType.Oxford}, width {OXFORD_CHIP_WIDTH}")
+    SSX_LOGGER.warning(f"MAP TO UPLOAD: {chip_map}")
     for block in range(1, 65):
         value = 1 if block in chip_map else 0
         pvar = PVAR_TEMPLATE % block
@@ -264,7 +265,7 @@ def upload_chip_map_to_geobrick(pmac: PMAC, chip_map: list[int]) -> MsgGenerator
         yield from bps.abs_set(pmac.pmac_string, pvar_str, wait=True)
         # Wait for PMAC to be done processing PVAR string
         yield from bps.sleep(0.02)
-    SSX_LOGGER.debug("Upload parameters done.")
+    SSX_LOGGER.info("Upload parameters done.")
 
 
 @log_on_entry

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/beamlines/i24/serial/web_gui_plans/general_plans.py

@@ -3,19 +3,34 @@ from typing import Literal
 
 import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
-from blueapi.core import MsgGenerator
+from bluesky.utils import MsgGenerator
 from dodal.beamlines import i24
 from dodal.common import inject
+from dodal.devices.hutch_shutter import HutchShutter
+from dodal.devices.i24.aperture import Aperture
+from dodal.devices.i24.beam_center import DetectorBeamCenter
+from dodal.devices.i24.beamstop import Beamstop
+from dodal.devices.i24.dcm import DCM
 from dodal.devices.i24.dual_backlight import BacklightPositions, DualBacklight
+from dodal.devices.i24.focus_mirrors import FocusMirrorsMode
 from dodal.devices.i24.i24_detector_motion import DetectorMotion
+from dodal.devices.i24.pilatus_metadata import PilatusMetadata
 from dodal.devices.i24.pmac import PMAC
-from dodal.devices.oav.oav_detector import OAV
+from dodal.devices.oav.oav_detector import OAVBeamCentreFile
+from dodal.devices.zebra.zebra import Zebra
 
+from mx_bluesky.beamlines.i24.serial.dcid import DCID
 from mx_bluesky.beamlines.i24.serial.fixed_target.ft_utils import (
     ChipType,
     MappingType,
     PumpProbeSetting,
 )
+from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_Chip_Collect_py3v1 import (
+    run_plan_in_wrapper,
+)
+from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_Chip_Manager_py3v1 import (
+    upload_chip_map_to_geobrick,
+)
 from mx_bluesky.beamlines.i24.serial.fixed_target.i24ssx_moveonclick import (
     _move_on_mouse_click_plan,
 )
@@ -24,6 +39,7 @@ from mx_bluesky.beamlines.i24.serial.log import (
     _read_visit_directory_from_file,
 )
 from mx_bluesky.beamlines.i24.serial.parameters import (
+    DetectorName,
     FixedTargetParameters,
     get_chip_format,
 )
@@ -46,9 +62,19 @@ def gui_move_backlight(
     SSX_LOGGER.debug(f"Backlight moved to {bl_pos.value}")
 
 
+@bpp.run_decorator()
+def gui_set_zoom_level(
+    position: str, oav: OAVBeamCentreFile = inject("oav")
+) -> MsgGenerator:
+    yield from bps.abs_set(oav.zoom_controller, position, wait=True)
+    SSX_LOGGER.debug(f"Setting zoom level to {position}")
+
+
 @bpp.run_decorator()
 def gui_stage_move_on_click(
-    position_px: tuple[int, int], oav: OAV = inject("oav"), pmac: PMAC = inject("pmac")
+    position_px: tuple[int, int],
+    oav: OAVBeamCentreFile = inject("oav"),
+    pmac: PMAC = inject("pmac"),
 ) -> MsgGenerator:
     yield from _move_on_mouse_click_plan(oav, pmac, position_px)
 
@@ -88,7 +114,7 @@ def gui_move_detector(
 
 
 @bpp.run_decorator()
-def gui_set_parameters(
+def gui_run_chip_collection(
     sub_dir: str,
     chip_name: str,
     exp_time: float,
@@ -103,6 +129,18 @@ def gui_set_parameters(
     laser_dwell: float,
     laser_delay: float,
     pre_pump: float,
+    pmac: PMAC = inject("pmac"),
+    zebra: Zebra = inject("zebra"),
+    aperture: Aperture = inject("aperture"),
+    backlight: DualBacklight = inject("backlight"),
+    beamstop: Beamstop = inject("beamstop"),
+    detector_stage: DetectorMotion = inject("detector_motion"),
+    shutter: HutchShutter = inject("shutter"),
+    dcm: DCM = inject("dcm"),
+    mirrors: FocusMirrorsMode = inject("focus_mirrors"),
+    beam_center_pilatus: DetectorBeamCenter = inject("pilatus_bc"),
+    beam_center_eiger: DetectorBeamCenter = inject("eiger_bc"),
+    pilatus_metadata: PilatusMetadata = inject("pilatus_meta"),
 ) -> MsgGenerator:
     """Set the parameter model for the data collection.
 
@@ -132,7 +170,6 @@ def gui_set_parameters(
     """
     # NOTE still a work in progress, adding to it as the ui grows
     # See progression of https://github.com/DiamondLightSource/mx-daq-ui/issues/3
-    detector_stage = i24.detector_motion()
     det_type = yield from get_detector_type(detector_stage)
     _format = chip_format if ChipType[chip_type] is ChipType.Custom else None
     chip_params = get_chip_format(ChipType[chip_type], _format)
@@ -164,6 +201,38 @@ def gui_set_parameters(
         "checker_pattern": checker_pattern,
         "pre_pump_exposure_s": pre_pump,
     }
-    # TODO run the run_fixed_target plan once params are set (GUI not ready yet)
-    yield from bps.sleep(0.5)
-    return FixedTargetParameters(**params)
+
+    parameters = FixedTargetParameters(**params)
+
+    # Create collection directory
+    parameters.collection_directory.mkdir(parents=True, exist_ok=True)
+
+    if parameters.chip_map:
+        yield from upload_chip_map_to_geobrick(pmac, parameters.chip_map)
+
+    beam_center_device = (
+        beam_center_eiger
+        if parameters.detector_name is DetectorName.EIGER
+        else beam_center_pilatus
+    )
+    SSX_LOGGER.info("Beam center device ready")
+
+    # DCID instance - do not create yet
+    dcid = DCID(emit_errors=False, expt_params=parameters)  # noqa
+    SSX_LOGGER.info("DCID created")
+
+    yield from run_plan_in_wrapper(
+        zebra,
+        pmac,
+        aperture,
+        backlight,
+        beamstop,
+        detector_stage,
+        shutter,
+        dcm,
+        mirrors,
+        beam_center_device,
+        parameters,
+        dcid,
+        pilatus_metadata,
+    )

{mx_bluesky-1.4.9 → mx_bluesky-1.5.0}/src/mx_bluesky/common/device_setup_plans/manipulate_sample.py

@@ -10,6 +10,7 @@ from dodal.devices.detector.detector_motion import DetectorMotion
 from dodal.devices.smargon import CombinedMove, Smargon
 
 from mx_bluesky.common.utils.log import LOGGER
+from mx_bluesky.hyperion.parameters.constants import CONST
 
 LOWER_DETECTOR_SHUTTER_AFTER_SCAN = True
 
@@ -21,6 +22,8 @@ def setup_sample_environment(
     group="setup_senv",
 ):
     """Move the aperture into required position, move out the backlight."""
+    yield from bps.abs_set(backlight, BacklightPosition.OUT, group=group)
+
     aperture_value = (
         None
         if not aperture_position_gda_name
@@ -29,7 +32,6 @@ def setup_sample_environment(
     yield from move_aperture_if_required(
         aperture_scatterguard, aperture_value, group=group
     )
-    yield from bps.abs_set(backlight, BacklightPosition.OUT, group=group)
 
 
 def move_aperture_if_required(
@@ -46,6 +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.abs_set(
             aperture_scatterguard.selected_aperture,
             aperture_value,

{mx_bluesky-1.4.9/src/mx_bluesky/hyperion → mx_bluesky-1.5.0/src/mx_bluesky/common}/device_setup_plans/utils.py

@@ -3,12 +3,8 @@ from collections.abc import Generator
 from bluesky import plan_stubs as bps
 from bluesky import preprocessors as bpp
 from bluesky.utils import Msg
-from dodal.devices.detector import (
-    DetectorParams,
-)
 from dodal.devices.detector.detector_motion import DetectorMotion, ShutterState
 from dodal.devices.eiger import EigerDetector
-from dodal.devices.i03.dcm import DCM
 from dodal.devices.mx_phase1.beamstop import Beamstop, BeamstopPositions
 
 from mx_bluesky.common.device_setup_plans.position_detector import (
@@ -17,13 +13,6 @@ from mx_bluesky.common.device_setup_plans.position_detector import (
 )
 
 
-def fill_in_energy_if_not_supplied(dcm: DCM, detector_params: DetectorParams):
-    if not detector_params.expected_energy_ev:
-        actual_energy_ev = 1000 * (yield from bps.rd(dcm.energy_in_kev))
-        detector_params.expected_energy_ev = actual_energy_ev
-    return detector_params
-
-
 def start_preparing_data_collection_then_do_plan(
     beamstop: Beamstop,
     eiger: EigerDetector,

{mx_bluesky-1.4.9/src/mx_bluesky/common/plans → mx_bluesky-1.5.0/src/mx_bluesky/common/experiment_plans}/common_flyscan_xray_centre_plan.py

@@ -7,35 +7,32 @@ from functools import partial
 import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
 import numpy as np
-import pydantic
 from bluesky.protocols import Readable
 from bluesky.utils import MsgGenerator
-from dodal.devices.eiger import EigerDetector
 from dodal.devices.fast_grid_scan import (
     FastGridScanCommon,
 )
-from dodal.devices.smargon import Smargon
-from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zocalo import ZocaloResults
 from dodal.devices.zocalo.zocalo_results import (
     XrcResult,
     get_full_processing_results,
 )
 
+from mx_bluesky.common.experiment_plans.inner_plans.do_fgs import (
+    ZOCALO_STAGE_GROUP,
+    kickoff_and_complete_gridscan,
+)
+from mx_bluesky.common.experiment_plans.read_hardware import (
+    read_hardware_plan,
+)
 from mx_bluesky.common.parameters.constants import (
     DocDescriptorNames,
     GridscanParamConstants,
     PlanGroupCheckpointConstants,
     PlanNameConstants,
 )
+from mx_bluesky.common.parameters.device_composites import FlyScanEssentialDevices
 from mx_bluesky.common.parameters.gridscan import SpecifiedThreeDGridScan
-from mx_bluesky.common.plans.inner_plans.do_fgs import (
-    ZOCALO_STAGE_GROUP,
-    kickoff_and_complete_gridscan,
-)
-from mx_bluesky.common.plans.read_hardware import (
-    read_hardware_plan,
-)
 from mx_bluesky.common.utils.exceptions import (
     CrystalNotFoundException,
     SampleException,
@@ -45,14 +42,6 @@ from mx_bluesky.common.utils.tracing import TRACER
 from mx_bluesky.common.xrc_result import XRayCentreResult
 
 
-@pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})
-class FlyScanEssentialDevices:
-    eiger: EigerDetector
-    synchrotron: Synchrotron
-    zocalo: ZocaloResults
-    smargon: Smargon
-
-
 @dataclasses.dataclass
 class BeamlineSpecificFGSFeatures:
     setup_trigger_plan: Callable[..., MsgGenerator]
@@ -251,6 +240,9 @@ def run_gridscan(
         parameters.scan_indices,
         plan_during_collection=beamline_specific.read_during_collection_plan,
     )
+
+    # GDA's gridscans requires Z steps to be at 0, so make sure we leave this device
+    # in a GDA-happy state.
     yield from bps.abs_set(beamline_specific.fgs_motors.z_steps, 0, wait=False)