mx-bluesky 1.5.11__py3-none-any.whl → 1.5.14__py3-none-any.whl

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

@@ -2,9 +2,6 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from mx_bluesky.common.external_interaction.callbacks.common.logging_callback import (
-    format_doc_for_log,
-)
 from mx_bluesky.common.external_interaction.callbacks.common.plan_reactive_callback import (
     PlanReactiveCallback,
 )
@@ -14,7 +11,7 @@ from mx_bluesky.common.external_interaction.nexus.nexus_utils import (
     vds_type_based_on_bit_depth,
 )
 from mx_bluesky.common.external_interaction.nexus.write_nexus import NexusWriter
-from mx_bluesky.common.utils.log import NEXUS_LOGGER
+from mx_bluesky.common.utils.log import NEXUS_LOGGER, format_doc_for_log
 from mx_bluesky.hyperion.parameters.constants import CONST, I03Constants
 from mx_bluesky.hyperion.parameters.rotation import SingleRotationScan
 

mx_bluesky/hyperion/external_interaction/config_server.py

@@ -2,15 +2,15 @@ from functools import cache
 
 from mx_bluesky.common.external_interaction.config_server import MXConfigClient
 from mx_bluesky.hyperion.parameters.constants import (
-    HyperionFeatureSetting,
-    HyperionFeatureSettingSources,
+    HyperionFeatureSettings,
+    HyperionFeatureSettingsSources,
 )
 
 
 @cache
-def get_hyperion_config_client() -> MXConfigClient[HyperionFeatureSetting]:
+def get_hyperion_config_client() -> MXConfigClient[HyperionFeatureSettings]:
     return MXConfigClient(
-        feature_sources=HyperionFeatureSettingSources,
-        feature_dc=HyperionFeatureSetting,
+        feature_sources=HyperionFeatureSettingsSources,
+        feature_dc=HyperionFeatureSettings,
         url="https://daq-config.diamond.ac.uk",
     )

mx_bluesky/hyperion/parameters/constants.py

@@ -8,7 +8,7 @@ from mx_bluesky.common.parameters.constants import (
     DocDescriptorNames,
     EnvironmentConstants,
     ExperimentParamConstants,
-    FeatureSetting,
+    FeatureSettings,
     FeatureSettingSources,
     HardwareConstants,
     OavConstants,
@@ -32,20 +32,27 @@ class I03Constants:
 
 
 # These currently exist in GDA domain.properties
-class HyperionFeatureSettingSources(FeatureSettingSources):
+class HyperionFeatureSettingsSources(FeatureSettingSources):
     USE_GPU_RESULTS = "gda.mx.hyperion.xrc.use_gpu_results"
     USE_PANDA_FOR_GRIDSCAN = "gda.mx.hyperion.use_panda_for_gridscans"
     SET_STUB_OFFSETS = "gda.mx.hyperion.do_stub_offsets"
     PANDA_RUNUP_DISTANCE_MM = "gda.mx.hyperion.panda_runup_distance_mm"
+    DETECTOR_DISTANCE_LIMIT_MAX_MM = "gda.detector.distance.limit.max"
+    DETECTOR_DISTANCE_LIMIT_MIN_MM = "gda.detector.distance.limit.min"
+    BEAMSTOP_DIODE_CHECK = "gda.mx.hyperion.enable_beamstop_diode_check"
 
 
 # Use these defaults if we can't read from the config server
 @dataclass
-class HyperionFeatureSetting(FeatureSetting):
+class HyperionFeatureSettings(FeatureSettings):
     USE_GPU_RESULTS: bool = True
     USE_PANDA_FOR_GRIDSCAN: bool = False
     SET_STUB_OFFSETS: bool = False
     PANDA_RUNUP_DISTANCE_MM: float = 0.16
+    # From GDA mx-config hutch_utilities.py default values
+    DETECTOR_DISTANCE_LIMIT_MAX_MM: float = 700
+    DETECTOR_DISTANCE_LIMIT_MIN_MM: float = 250
+    BEAMSTOP_DIODE_CHECK: bool = False
 
 
 @dataclass(frozen=True)

mx_bluesky/hyperion/parameters/device_composites.py

@@ -13,10 +13,11 @@ from dodal.devices.fast_grid_scan import (
     ZebraFastGridScanThreeD,
 )
 from dodal.devices.flux import Flux
+from dodal.devices.i03.beamsize import Beamsize
 from dodal.devices.robot import BartRobot
 from dodal.devices.s4_slit_gaps import S4SlitGaps
 from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.undulator import Undulator
+from dodal.devices.undulator import UndulatorInKeV
 from dodal.devices.xbpm_feedback import XBPMFeedback
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_controlled_shutter import ZebraShutter
@@ -41,7 +42,7 @@ class HyperionFlyScanXRayCentreComposite(FlyScanEssentialDevices):
     eiger: EigerDetector
     flux: Flux
     s4_slit_gaps: S4SlitGaps
-    undulator: Undulator
+    undulator: UndulatorInKeV
     synchrotron: Synchrotron
     zebra: Zebra
     zocalo: ZocaloResults
@@ -52,6 +53,7 @@ class HyperionFlyScanXRayCentreComposite(FlyScanEssentialDevices):
     backlight: Backlight
     xbpm_feedback: XBPMFeedback
     zebra_fast_grid_scan: ZebraFastGridScanThreeD
+    beamsize: Beamsize
 
 
 @pydantic.dataclasses.dataclass(config={"arbitrary_types_allowed": True})

mx_bluesky/hyperion/parameters/robot_load.py

@@ -1,5 +1,3 @@
-from pydantic import Field
-
 from mx_bluesky.common.parameters.components import (
     MxBlueskyParameters,
     WithOptionalEnergyChange,
@@ -7,9 +5,6 @@ from mx_bluesky.common.parameters.components import (
     WithSnapshot,
     WithVisit,
 )
-from mx_bluesky.common.parameters.constants import (
-    HardwareConstants,
-)
 from mx_bluesky.hyperion.parameters.gridscan import (
     GridCommonWithHyperionDetectorParams,
     PinTipCentreThenXrayCentre,
@@ -19,12 +14,10 @@ from mx_bluesky.hyperion.parameters.gridscan import (
 class RobotLoadAndEnergyChange(
     MxBlueskyParameters, WithSample, WithSnapshot, WithOptionalEnergyChange, WithVisit
 ):
-    thawing_time: float = Field(default=HardwareConstants.THAWING_TIME)
+    pass
 
 
 class RobotLoadThenCentre(GridCommonWithHyperionDetectorParams):
-    thawing_time: float = Field(default=HardwareConstants.THAWING_TIME)
-
     @property
     def robot_load_params(self) -> RobotLoadAndEnergyChange:
         my_params = self.model_dump()
@@ -33,5 +26,4 @@ class RobotLoadThenCentre(GridCommonWithHyperionDetectorParams):
     @property
     def pin_centre_then_xray_centre_params(self) -> PinTipCentreThenXrayCentre:
         my_params = self.model_dump()
-        del my_params["thawing_time"]
         return PinTipCentreThenXrayCentre(**my_params)

mx_bluesky/hyperion/plan_runner.py

@@ -1,7 +1,9 @@
 import threading
+import time
 from collections.abc import Callable
 
 from blueapi.core import BlueskyContext
+from bluesky import plan_stubs as bps
 from bluesky.utils import MsgGenerator, RequestAbort
 
 from mx_bluesky.common.parameters.constants import Status
@@ -19,10 +21,15 @@ class PlanError(Exception):
 class PlanRunner(BaseRunner):
     """Runner that executes experiments from inside a running Bluesky plan"""
 
+    EXTERNAL_CALLBACK_WATCHDOG_TIMER_S = 60
+    EXTERNAL_CALLBACK_POLL_INTERVAL_S = 1
+
     def __init__(self, context: BlueskyContext, dev_mode: bool) -> None:
         super().__init__(context)
         self.current_status: Status = Status.IDLE
         self.is_dev_mode = dev_mode
+        self._callbacks_started = False
+        self._callback_watchdog_expiry = time.monotonic()
 
     def execute_plan(
         self,
@@ -38,6 +45,20 @@ class PlanRunner(BaseRunner):
         self.current_status = Status.BUSY
 
         try:
+            callback_expiry = time.monotonic() + self.EXTERNAL_CALLBACK_WATCHDOG_TIMER_S
+            while time.monotonic() < callback_expiry:
+                if self._callbacks_started:
+                    break
+                # If on first launch the external callbacks aren't started yet, wait until they are
+                LOGGER.info("Waiting for external callbacks to start")
+                yield from bps.sleep(self.EXTERNAL_CALLBACK_POLL_INTERVAL_S)
+            else:
+                raise RuntimeError("External callbacks not running - try restarting")
+
+            if not self._external_callbacks_are_alive():
+                raise RuntimeError(
+                    "External callback watchdog timer expired, check external callbacks are running."
+                )
             yield from experiment()
             self.current_status = Status.IDLE
         except WarningError as e:
@@ -74,3 +95,13 @@ class PlanRunner(BaseRunner):
             stopping_thread = threading.Thread(target=issue_abort)
             stopping_thread.start()
             return
+
+    def reset_callback_watchdog_timer(self):
+        """Called periodically to reset the watchdog timer when the external callbacks ping us."""
+        self._callbacks_started = True
+        self._callback_watchdog_expiry = (
+            time.monotonic() + self.EXTERNAL_CALLBACK_WATCHDOG_TIMER_S
+        )
+
+    def _external_callbacks_are_alive(self) -> bool:
+        return time.monotonic() < self._callback_watchdog_expiry

mx_bluesky/hyperion/plan_runner_api.py

@@ -24,10 +24,11 @@ def create_server_for_udc(runner: PlanRunner) -> Thread:  # pragma: no cover
     return flask_thread
 
 
-def create_app_for_udc(runner):
+def create_app_for_udc(runner: PlanRunner):
     app = Flask(__name__)
     api = Api(app)
     api.add_resource(StatusResource, "/status", resource_class_args=[runner])
+    api.add_resource(CallbackLiveness, "/callbackPing", resource_class_args=[runner])
     return app
 
 
@@ -41,3 +42,15 @@ class StatusResource(Resource):
     def get(self):
         status = self._runner.current_status
         return {"status": status.value}
+
+
+class CallbackLiveness(Resource):
+    """Called periodically by the external callbacks to indicate that they are still running"""
+
+    def __init__(self, runner: PlanRunner):
+        super().__init__()
+        self._runner = runner
+
+    def get(self):
+        LOGGER.debug("External callback ping received.")
+        self._runner.reset_callback_watchdog_timer()

mx_bluesky/hyperion/utils/context.py

@@ -27,8 +27,8 @@ def clear_all_device_caches(context: BlueskyContext):
 
 
 def setup_devices(context: BlueskyContext, dev_mode: bool):
-    _, exceptions = context.with_dodal_module(
-        get_beamline_based_on_environment_variable(),
+    _, exceptions = context.with_device_manager(
+        get_beamline_based_on_environment_variable().devices,
         mock=dev_mode,
     )
     if exceptions:

mx_bluesky/jupyter_example.ipynb

@@ -48,6 +48,14 @@
     "\n",
     "run_engine(scan(dets, motor, -1, 1, 10))"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d117ffc8-882c-44fb-b65d-7e57544255d4",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -66,7 +74,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.4"
+   "version": "3.12.11"
   }
  },
  "nbformat": 4,

{mx_bluesky-1.5.11.dist-info → mx_bluesky-1.5.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.11
+Version: 1.5.14
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -218,11 +218,10 @@ Requires-Dist: annotated_types
 Requires-Dist: caproto
 Requires-Dist: fastapi[all]
 Requires-Dist: flask-restful
-Requires-Dist: ispyb
 Requires-Dist: jupyterlab
 Requires-Dist: matplotlib
 Requires-Dist: nexgen>=0.11.0
-Requires-Dist: numpy==2.2.6
+Requires-Dist: numpy>=2.3.5
 Requires-Dist: opencv-python
 Requires-Dist: opentelemetry-distro
 Requires-Dist: opentelemetry-exporter-otlp
@@ -238,17 +237,18 @@ Requires-Dist: deepdiff
 Requires-Dist: matplotlib
 Requires-Dist: cachetools
 Requires-Dist: daq-config-server>=v1.0.0-rc.2
-Requires-Dist: blueapi>=1.6.3
+Requires-Dist: blueapi>=1.8.0
 Requires-Dist: ophyd>=1.10.5
-Requires-Dist: ophyd-async>=0.13.5
+Requires-Dist: ophyd-async>=0.14.0
 Requires-Dist: bluesky>=1.14.6
-Requires-Dist: dls-dodal==1.65.0
+Requires-Dist: dls-dodal==1.67.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: diff-cover; extra == "dev"
 Requires-Dist: GitPython; extra == "dev"
 Requires-Dist: import-linter; extra == "dev"
+Requires-Dist: ispyb; extra == "dev"
 Requires-Dist: ipython; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: myst-parser; extra == "dev"
@@ -262,6 +262,7 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-random-order; extra == "dev"
 Requires-Dist: pytest-timeout; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: responses; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: sphinx-autobuild; extra == "dev"
 Requires-Dist: sphinx-copybutton; extra == "dev"