From 2a8530ddf4885e5722afa239b9f6f2095c6cd0dc Mon Sep 17 00:00:00 2001
From: Callum Forrester <callum.forrester@diamond.ac.uk>
Date: Wed, 22 Jan 2025 09:17:30 +0000
Subject: [PATCH] Add diagnostic module

---
 src/htss_rig_bluesky/plans/diagnostic.py | 80 ++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 src/htss_rig_bluesky/plans/diagnostic.py

diff --git a/src/htss_rig_bluesky/plans/diagnostic.py b/src/htss_rig_bluesky/plans/diagnostic.py
new file mode 100644
index 0000000..3983100
--- /dev/null
+++ b/src/htss_rig_bluesky/plans/diagnostic.py
@@ -0,0 +1,80 @@
+import bluesky.plan_stubs as bps
+import bluesky.preprocessors as bpp
+from bluesky.utils import MsgGenerator
+from dodal.plans.scanspec import spec_scan
+from dodal.plans.wrapped import count
+from ophyd_async.epics.adaravis import AravisDetector
+from ophyd_async.epics.motor import Motor
+from scanspec.specs import Line
+
+
+def detector_diagnostic(detector: AravisDetector) -> MsgGenerator[None]:
+    diagnostic_fields = {component for _, component in detector.drv.children()}.union(
+        {component for _, component in detector.hdf.children()}
+    )
+
+    yield from bps.abs_set(
+        detector.drv.acquire_time,
+        0.1,
+        wait=False,
+        group="setup",
+    )
+    yield from bps.abs_set(
+        detector.drv.acquire_period,
+        detector.controller.get_deadtime(0.1),
+        wait=False,
+        group="setup",
+    )
+    yield from bps.abs_set(
+        detector.drv.num_images,
+        1,
+        wait=False,
+        group="setup",
+    )
+    yield from bps.wait(group="setup")
+
+    for i in [1, 10, 100, 100, 100, 1000]:
+        yield from bpp.monitor_during_wrapper(
+            count([detector], num=i), diagnostic_fields
+        )
+
+
+def motor_diagnostic(motor: Motor) -> MsgGenerator[None]:
+    initial_velocity = yield from bps.rd(motor.velocity)
+    max_velocity = yield from bps.rd(motor.max_velocity)
+    low_limit, high_limit = yield from padded_limits(motor)
+
+    diagnostic_fields = {
+        motor.acceleration_time,
+        motor.velocity,
+        motor.max_velocity,
+        motor.high_limit_travel,
+        motor.low_limit_travel,
+        motor.user_readback,
+        motor.user_setpoint,
+    }
+
+    scanspec = Line(motor.velocity, max_velocity / 10.0, max_velocity, 5) * ~Line(
+        motor, low_limit, high_limit, 1
+    )
+
+    # Drive the motor back and forth at different velocities,
+    # monitoring paramters asynchronously
+    yield from bpp.monitor_during_wrapper(
+        spec_scan(diagnostic_fields, scanspec),
+        diagnostic_fields,
+    )
+
+    # Put veloicty back how we found it
+    yield from bps.abs_set(motor.velocity, initial_velocity)
+
+
+def padded_limits(
+    motor: Motor, padding_percent: float = 0.05
+) -> MsgGenerator[tuple[float, float]]:
+    high_limit_travel = yield from bps.rd(motor.high_limit_travel)
+    low_limit_travel = yield from bps.rd(motor.low_limit_travel)
+
+    return low_limit_travel + (
+        low_limit_travel * padding_percent
+    ), high_limit_travel - (high_limit_travel * padding_percent)