extract flying scan trigger and read logic into common.

Author: Relm-Arrowny

src/sm_bluesky/common/plan_stubs/__init__.py

@@ -1,4 +1,4 @@
-from .detectors import set_area_detector_acquire_time
+from .detection import fly_trigger_and_read, set_area_detector_acquire_time
 from .motions import (
     MotorTable,
     cache_speed,
@@ -20,4 +20,5 @@
     "get_velocity_and_step_size",
     "cache_speed",
     "restore_speed",
+    "fly_trigger_and_read",
 ]

src/sm_bluesky/common/plan_stubs/detectors.py renamed to src/sm_bluesky/common/plan_stubs/detection.py

@@ -1,8 +1,15 @@
+from typing import Any
+
+import bluesky.plan_stubs as bps
 from blueapi.core import MsgGenerator
 from bluesky.plan_stubs import abs_set
-from bluesky.utils import plan
+from bluesky.protocols import Flyable
+from bluesky.utils import plan, short_uid
+from ophyd_async.core import FlyMotorInfo
 from ophyd_async.epics.adcore import AreaDetector, SingleTriggerDetector
 
+from sm_bluesky.log import LOGGER
+
 
 @plan
 def set_area_detector_acquire_time(
@@ -27,3 +34,19 @@ def set_area_detector_acquire_time(
     """
     drv = det.drv if isinstance(det, SingleTriggerDetector) else det.driver
     yield from abs_set(drv.acquire_time, acquire_time, wait=wait)
+
+
+@plan
+def fly_trigger_and_read(
+    motor: Flyable,
+    fly_info: FlyMotorInfo,
+    dets: list[Any],
+) -> MsgGenerator:
+    grp = short_uid("kickoff")
+    yield from bps.kickoff(motor, group=grp, wait=True)
+    LOGGER.info(f"flying motor =  {motor.name} at with info = {fly_info}")
+    done = yield from bps.complete(motor)
+    yield from bps.trigger_and_read(dets + [motor])
+    while not done.done:
+        yield from bps.trigger_and_read(dets + [motor])
+        yield from bps.checkpoint()

src/sm_bluesky/common/plans/fast_energy_scan.py

@@ -0,0 +1,56 @@
+from typing import Any
+
+import bluesky.plan_stubs as bps
+import bluesky.preprocessors as bpp
+from blueapi.core import MsgGenerator
+from bluesky.preprocessors import (
+    finalize_wrapper,
+)
+from bluesky.protocols import Readable
+from bluesky.utils import plan
+from dodal.devices.apple2_undulator import EnergySetter
+from dodal.plan_stubs.data_session import attach_data_session_metadata_decorator
+from ophyd_async.core import FlyMotorInfo
+
+from sm_bluesky.common.plan_stubs import (
+    cache_speed,
+    fly_trigger_and_read,
+    restore_speed,
+)
+
+
+@plan
+@attach_data_session_metadata_decorator()
+def soft_fly_energy_scan(
+    energy_device: EnergySetter,
+    energy_start: float,
+    energy_end: float,
+    energy_step: float,
+    count_time: float,
+    dets: list[Readable],
+    md: dict[str, Any] | None = None,
+):
+    old_speeds = yield from cache_speed(
+        [energy_device.pgm_ref().energy, energy_device.id.gap]
+    )
+
+    fly_info = FlyMotorInfo(
+        start_position=energy_start,
+        end_position=energy_end,
+        time_for_move=abs(energy_end - energy_start) / energy_step * count_time,
+    )
+
+    @bpp.stage_decorator(dets)
+    @bpp.run_decorator(md=md)
+    def inn_fly_energy_scan(
+        energy_device: EnergySetter,
+        fly_info: FlyMotorInfo,
+        dets: list[Readable],
+    ) -> MsgGenerator:
+        yield from bps.prepare(energy_device, fly_info, wait=True)
+        yield from fly_trigger_and_read(energy_device, fly_info, dets)
+
+    yield from finalize_wrapper(
+        plan=inn_fly_energy_scan(energy_device, fly_info, dets),
+        final_plan=restore_speed(old_speeds),
+    )

src/sm_bluesky/common/plans/fast_scan.py

@@ -14,7 +14,12 @@
 from ophyd_async.epics.motor import Motor
 
 from sm_bluesky.common.helper import add_extra_names_to_meta
-from sm_bluesky.common.plan_stubs import cache_speed, check_within_limit, restore_speed
+from sm_bluesky.common.plan_stubs import (
+    cache_speed,
+    check_within_limit,
+    fly_trigger_and_read,
+    restore_speed,
+)
 from sm_bluesky.log import LOGGER
 
 
@@ -252,14 +257,7 @@ def inner_fast_scan_1d(
             time_for_move=abs(start - end) / motor_speed,
         )
         yield from bps.prepare(motor, fly_info, group=grp, wait=True)
-        yield from bps.wait(group=grp)
-        yield from bps.kickoff(motor, group=grp, wait=True)
-        LOGGER.info(f"flying motor =  {motor.name} at speed = {motor_speed}")
-        done = yield from bps.complete(motor)
-        yield from bps.trigger_and_read(dets + [motor])
-        while not done.done:
-            yield from bps.trigger_and_read(dets + [motor])
-            yield from bps.checkpoint()
+        yield from fly_trigger_and_read(motor, fly_info, dets)
 
     yield from finalize_wrapper(
         plan=inner_fast_scan_1d(dets, motor, start, end, motor_speed),