New external parameter model

.vscode/launch.json

@@ -42,7 +42,7 @@
                 "debug-test"
             ],
             "env": {
-                "PYTEST_ADDOPTS": "--no-cov --random-order"
+                "PYTEST_ADDOPTS": "--no-cov --random-order -vv"
             },
         }
     ]

conftest.py

@@ -4,6 +4,8 @@
 
 import pytest
 
+environ["HYPERION_TEST_MODE"] = "true"
+
 print("Adjusting S03 EPICS environment ...")
 s03_epics_server_port = getenv("S03_EPICS_CA_SERVER_PORT")
 s03_epics_repeater_port = getenv("S03_EPICS_CA_REPEATER_PORT")

src/hyperion/__main__.py

@@ -1,4 +1,5 @@
 import atexit
+import json
 import threading
 from dataclasses import asdict
 from queue import Queue
@@ -34,8 +35,8 @@
 )
 from hyperion.log import LOGGER, do_default_logging_setup
 from hyperion.parameters.cli import parse_cli_args
+from hyperion.parameters.components import HyperionParameters
 from hyperion.parameters.constants import CONST, Actions, Status
-from hyperion.parameters.internal_parameters import InternalParameters
 from hyperion.tracing import TRACER
 from hyperion.utils.context import setup_context
 
@@ -47,7 +48,7 @@ class Command:
     action: Actions
     devices: Optional[Any] = None
     experiment: Optional[Callable[[Any, Any], MsgGenerator]] = None
-    parameters: Optional[InternalParameters] = None
+    parameters: Optional[HyperionParameters] = None
     callbacks: Optional[CallbacksFactory] = None
 
 
@@ -109,7 +110,7 @@ def __init__(
     def start(
         self,
         experiment: Callable,
-        parameters: InternalParameters,
+        parameters: HyperionParameters,
         plan_name: str,
         callbacks: Optional[CallbacksFactory],
     ) -> StatusAndMessage:
@@ -225,13 +226,12 @@ def compose_start_args(context: BlueskyContext, plan_name: str, action: Actions)
         raise PlanNotFound(
             f"Experiment plan '{plan_name}' not found in context. Context has {context.plan_functions.keys()}"
         )
-
-    parameters = experiment_internal_param_type.from_json(request.data)
-    if plan_name != parameters.hyperion_params.experiment_type:
-        raise PlanNotFound(
-            f"Wrong experiment parameters ({parameters.hyperion_params.experiment_type}) "
-            f"for plan endpoint {plan_name}."
-        )
+    try:
+        parameters = experiment_internal_param_type(**json.loads(request.data))
+    except Exception as e:
+        raise ValueError(
+            "Supplied parameters don't match the plan for this endpoint"
+        ) from e
     return plan, parameters, plan_name, callback_type
 
 

src/hyperion/experiment_plans/experiment_registry.py

@@ -19,28 +19,25 @@
     create_gridscan_callbacks,
     create_rotation_callbacks,
 )
+from hyperion.parameters.gridscan import (
+    GridScanWithEdgeDetect,
+    PinTipCentreThenXrayCentre,
+    RobotLoadThenCentre,
+    ThreeDGridScan,
+)
 from hyperion.parameters.plan_specific.grid_scan_with_edge_detect_params import (
-    GridScanWithEdgeDetectInternalParameters,
     GridScanWithEdgeDetectParams,
 )
-from hyperion.parameters.plan_specific.gridscan_internal_params import (
-    GridscanInternalParameters,
-)
-from hyperion.parameters.plan_specific.panda.panda_gridscan_internal_params import (
-    PandAGridscanInternalParameters,
-)
 from hyperion.parameters.plan_specific.pin_centre_then_xray_centre_params import (
-    PinCentreThenXrayCentreInternalParameters,
     PinCentreThenXrayCentreParams,
 )
 from hyperion.parameters.plan_specific.robot_load_then_center_params import (
-    RobotLoadThenCentreInternalParameters,
     RobotLoadThenCentreParams,
 )
 from hyperion.parameters.plan_specific.rotation_scan_internal_params import (
-    RotationInternalParameters,
     RotationScanParams,
 )
+from hyperion.parameters.rotation import RotationScan
 
 
 def not_implemented():
@@ -54,12 +51,11 @@ def do_nothing():
 class ExperimentRegistryEntry(TypedDict):
     setup: Callable
     internal_param_type: type[
-        GridscanInternalParameters
-        | GridScanWithEdgeDetectInternalParameters
-        | RotationInternalParameters
-        | PinCentreThenXrayCentreInternalParameters
-        | RobotLoadThenCentreInternalParameters
-        | PandAGridscanInternalParameters
+        ThreeDGridScan
+        | GridScanWithEdgeDetect
+        | RotationScan
+        | PinTipCentreThenXrayCentre
+        | RobotLoadThenCentre
     ]
     experiment_param_type: type[AbstractExperimentWithBeamParams]
     callbacks_factory: CallbacksFactory
@@ -69,37 +65,37 @@ class ExperimentRegistryEntry(TypedDict):
 PLAN_REGISTRY: dict[str, ExperimentRegistryEntry] = {
     "panda_flyscan_xray_centre": {
         "setup": panda_flyscan_xray_centre_plan.create_devices,
-        "internal_param_type": PandAGridscanInternalParameters,
+        "internal_param_type": ThreeDGridScan,
         "experiment_param_type": PandAGridScanParams,
         "callbacks_factory": create_gridscan_callbacks,
     },
     "flyscan_xray_centre": {
         "setup": flyscan_xray_centre_plan.create_devices,
-        "internal_param_type": GridscanInternalParameters,
+        "internal_param_type": ThreeDGridScan,
         "experiment_param_type": GridScanParams,
         "callbacks_factory": create_gridscan_callbacks,
     },
     "grid_detect_then_xray_centre": {
         "setup": grid_detect_then_xray_centre_plan.create_devices,
-        "internal_param_type": GridScanWithEdgeDetectInternalParameters,
+        "internal_param_type": GridScanWithEdgeDetect,
         "experiment_param_type": GridScanWithEdgeDetectParams,
         "callbacks_factory": create_gridscan_callbacks,
     },
     "rotation_scan": {
         "setup": rotation_scan_plan.create_devices,
-        "internal_param_type": RotationInternalParameters,
+        "internal_param_type": RotationScan,
         "experiment_param_type": RotationScanParams,
         "callbacks_factory": create_rotation_callbacks,
     },
     "pin_tip_centre_then_xray_centre": {
         "setup": pin_centre_then_xray_centre_plan.create_devices,
-        "internal_param_type": PinCentreThenXrayCentreInternalParameters,
+        "internal_param_type": PinTipCentreThenXrayCentre,
         "experiment_param_type": PinCentreThenXrayCentreParams,
         "callbacks_factory": create_gridscan_callbacks,
     },
     "robot_load_then_centre": {
         "setup": robot_load_then_centre_plan.create_devices,
-        "internal_param_type": RobotLoadThenCentreInternalParameters,
+        "internal_param_type": RobotLoadThenCentre,
         "experiment_param_type": RobotLoadThenCentreParams,
         "callbacks_factory": create_gridscan_callbacks,
     },

src/hyperion/experiment_plans/flyscan_xray_centre_plan.py

@@ -51,17 +51,17 @@
 from hyperion.exceptions import WarningException
 from hyperion.log import LOGGER
 from hyperion.parameters.constants import CONST
+from hyperion.parameters.gridscan import ThreeDGridScan
+from hyperion.parameters.plan_specific.gridscan_internal_params import (
+    GridscanInternalParameters,
+)
 from hyperion.tracing import TRACER
 from hyperion.utils.aperturescatterguard import (
     load_default_aperture_scatterguard_positions_if_unset,
 )
 from hyperion.utils.context import device_composite_from_context
 
 if TYPE_CHECKING:
-    from hyperion.parameters.plan_specific.gridscan_internal_params import (
-        GridscanInternalParameters,
-    )
-
     PandaOrZebraGridscan = FastGridScan | PandAFastGridScan
     from scanspec.core import AxesPoints, Axis
 
@@ -324,7 +324,7 @@ def run_gridscan_and_move(
 
 def flyscan_xray_centre(
     composite: FlyScanXRayCentreComposite,
-    parameters: Any,
+    parameters: ThreeDGridScan | GridscanInternalParameters | Any,
 ) -> MsgGenerator:
     """Create the plan to run the grid scan based on provided parameters.
 
@@ -337,15 +337,25 @@ def flyscan_xray_centre(
     Returns:
         Generator: The plan for the gridscan
     """
-    composite.eiger.set_detector_parameters(parameters.hyperion_params.detector_params)
-    composite.zocalo.zocalo_environment = parameters.hyperion_params.zocalo_environment
+
+    old_parameters = (
+        parameters
+        if isinstance(parameters, GridscanInternalParameters)
+        else parameters.old_parameters()
+    )
+    composite.eiger.set_detector_parameters(
+        old_parameters.hyperion_params.detector_params
+    )
+    composite.zocalo.zocalo_environment = (
+        old_parameters.hyperion_params.zocalo_environment
+    )
 
     @bpp.set_run_key_decorator(CONST.PLAN.GRIDSCAN_OUTER)
     @bpp.run_decorator(  # attach experiment metadata to the start document
         md={
             "subplan_name": CONST.PLAN.GRIDSCAN_OUTER,
             CONST.TRIGGER.ZOCALO: CONST.PLAN.DO_FGS,
-            "hyperion_internal_parameters": parameters.json(),
+            "hyperion_internal_parameters": old_parameters.json(),
             "activate_callbacks": [
                 "GridscanISPyBCallback",
                 "GridscanNexusFileCallback",
@@ -356,9 +366,9 @@ def flyscan_xray_centre(
     @transmission_and_xbpm_feedback_for_collection_decorator(
         composite.xbpm_feedback,
         composite.attenuator,
-        parameters.experiment_params.transmission_fraction,
+        old_parameters.experiment_params.transmission_fraction,
     )
     def run_gridscan_and_move_and_tidy(fgs_composite, params):
         yield from run_gridscan_and_move(fgs_composite, params)
 
-    return run_gridscan_and_move_and_tidy(composite, parameters)
+    return run_gridscan_and_move_and_tidy(composite, old_parameters)

src/hyperion/experiment_plans/grid_detect_then_xray_centre_plan.py

@@ -2,7 +2,7 @@
 
 import dataclasses
 import json
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 import numpy as np
 from blueapi.core import BlueskyContext, MsgGenerator
@@ -19,6 +19,7 @@
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAV_CONFIG_JSON, OAVParameters
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
+from dodal.devices.panda_fast_grid_scan import PandAFastGridScan
 from dodal.devices.robot import BartRobot
 from dodal.devices.s4_slit_gaps import S4SlitGaps
 from dodal.devices.smargon import Smargon
@@ -27,6 +28,7 @@
 from dodal.devices.xbpm_feedback import XBPMFeedback
 from dodal.devices.zebra import Zebra
 from dodal.devices.zocalo import ZocaloResults
+from ophyd_async.panda import PandA
 
 from hyperion.device_setup_plans.utils import (
     start_preparing_data_collection_then_do_plan,
@@ -51,6 +53,11 @@
     OavSnapshotCallback,
 )
 from hyperion.log import LOGGER
+from hyperion.parameters.gridscan import GridScanWithEdgeDetect
+from hyperion.parameters.plan_specific.grid_scan_with_edge_detect_params import (
+    GridScanWithEdgeDetectInternalParameters,
+    GridScanWithEdgeDetectParams,
+)
 from hyperion.parameters.plan_specific.gridscan_internal_params import (
     GridscanInternalParameters,
     GridScanParams,
@@ -64,14 +71,6 @@
 )
 from hyperion.utils.context import device_composite_from_context
 
-if TYPE_CHECKING:
-    from hyperion.parameters.plan_specific.grid_scan_with_edge_detect_params import (
-        GridScanWithEdgeDetectInternalParameters,
-        GridScanWithEdgeDetectParams,
-    )
-from dodal.devices.panda_fast_grid_scan import PandAFastGridScan
-from ophyd_async.panda import PandA
-
 
 @dataclasses.dataclass
 class GridDetectThenXRayCentreComposite:
@@ -249,28 +248,33 @@ def run_grid_detection_plan(
 
 def grid_detect_then_xray_centre(
     composite: GridDetectThenXRayCentreComposite,
-    parameters: Any,
+    parameters: GridScanWithEdgeDetectInternalParameters | GridScanWithEdgeDetect | Any,
     oav_config: str = OAV_CONFIG_JSON,
 ) -> MsgGenerator:
     """
     A plan which combines the collection of snapshots from the OAV and the determination
     of the grid dimensions to use for the following grid scan.
     """
+    old_parameters = (
+        parameters
+        if isinstance(parameters, GridScanWithEdgeDetectInternalParameters)
+        else parameters.old_parameters()
+    )
     eiger: EigerDetector = composite.eiger
 
-    eiger.set_detector_parameters(parameters.hyperion_params.detector_params)
+    eiger.set_detector_parameters(old_parameters.hyperion_params.detector_params)
 
     oav_params = OAVParameters("xrayCentring", oav_config)
 
     plan_to_perform = detect_grid_and_do_gridscan(
         composite,
-        parameters,
+        old_parameters,
         oav_params,
     )
 
     return start_preparing_data_collection_then_do_plan(
         eiger,
         composite.detector_motion,
-        parameters.hyperion_params.detector_params.detector_distance,
+        old_parameters.hyperion_params.detector_params.detector_distance,
         plan_to_perform,
     )