Implement a new access controlled shutter for i19 (#1135)

* A start

* Start adding REST call

* Small note on order of things

* Fill in some blanks

* Run pre-commits

* This should be working

* Run pre-commits

* Tidy up, add docstring and instantiate in beamlines

* Make pre commits happy

* Remove old shutter and tests

* Forgot an async

* Add read method and test

* Maybe add the file

* Fix dumb mistake

* Run pre-commits, again

* Maybe it can be simplified

* Add a test for exception

* Make ruff happy

* Add comment

* Comment out failing test

* Add test

* Add a couple of tests

* Remove tests for old shutter and rename file

* Update commet

* Update device to use new wrapper

* Remove hutch invalid option as logic now moved to i19-bluesky

* Get dodal connect to work for i19-1 and link issue

* Fix docstrings

* Update src/dodal/devices/i19/shutter.py

Co-authored-by: Dominic Oram <dominic.oram@diamond.ac.uk>

* Remove read

* Reword comment

* Pull device name for hutch control into constant

* Change log level

---------

Co-authored-by: Dominic Oram <dominic.oram@diamond.ac.uk>

Author: noemifrisina

src/dodal/beamlines/i19_1.py

@@ -5,7 +5,7 @@
     set_beamline as set_utils_beamline,
 )
 from dodal.devices.i19.beamstop import BeamStop
-from dodal.devices.i19.shutter import HutchConditionalShutter, HutchState
+from dodal.devices.i19.shutter import AccessControlledShutter, HutchState
 from dodal.devices.oav.oav_detector import OAV
 from dodal.devices.oav.oav_parameters import OAVConfig
 from dodal.devices.synchrotron import Synchrotron
@@ -67,11 +67,11 @@ def zebra() -> Zebra:
 
 
 @device_factory()
-def shutter() -> HutchConditionalShutter:
-    """Get the i19-2 hutch shutter device, instantiate it if it hasn't already been.
+def shutter() -> AccessControlledShutter:
+    """Get the i19-1 hutch shutter device, instantiate it if it hasn't already been.
     If this is called when already instantiated, it will return the existing object.
     """
-    return HutchConditionalShutter(
+    return AccessControlledShutter(
         prefix=f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
         hutch=HutchState.EH1,
     )

src/dodal/beamlines/i19_2.py

@@ -5,7 +5,7 @@
     set_beamline as set_utils_beamline,
 )
 from dodal.devices.i19.beamstop import BeamStop
-from dodal.devices.i19.shutter import HutchConditionalShutter, HutchState
+from dodal.devices.i19.shutter import AccessControlledShutter, HutchState
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.zebra.zebra import Zebra
 from dodal.devices.zebra.zebra_constants_mapping import (
@@ -52,11 +52,11 @@ def zebra() -> Zebra:
 
 
 @device_factory()
-def shutter() -> HutchConditionalShutter:
+def shutter() -> AccessControlledShutter:
     """Get the i19-2 hutch shutter device, instantiate it if it hasn't already been.
     If this is called when already instantiated, it will return the existing object.
     """
-    return HutchConditionalShutter(
+    return AccessControlledShutter(
         prefix=f"{PREFIX.beamline_prefix}-PS-SHTR-01:",
         hutch=HutchState.EH2,
     )

src/dodal/beamlines/i19_optics.py

@@ -5,7 +5,7 @@
     set_beamline as set_utils_beamline,
 )
 from dodal.devices.hutch_shutter import HutchShutter
-from dodal.devices.i19.hutch_access import HutchAccessControl
+from dodal.devices.i19.hutch_access import ACCESS_DEVICE_NAME, HutchAccessControl
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix
 
@@ -31,4 +31,6 @@ def access_control() -> HutchAccessControl:
     """Get a device that checks the active hutch for i19, instantiate it if it hasn't already been.
     If this is called when already instantiated, it will return the existing object.
     """
-    return HutchAccessControl(f"{PREFIX.beamline_prefix}-OP-STAT-01:", "access_control")
+    return HutchAccessControl(
+        f"{PREFIX.beamline_prefix}-OP-STAT-01:", ACCESS_DEVICE_NAME
+    )

src/dodal/devices/i19/hutch_access.py

@@ -1,6 +1,8 @@
 from ophyd_async.core import StandardReadable
 from ophyd_async.epics.core import epics_signal_r
 
+ACCESS_DEVICE_NAME = "access_control"  # Device name in i19-blueapi
+
 
 class HutchAccessControl(StandardReadable):
     def __init__(self, prefix: str, name: str = "") -> None:

src/dodal/devices/i19/shutter.py

@@ -1,61 +1,79 @@
 from enum import Enum
 
+from aiohttp import ClientSession
 from bluesky.protocols import Movable
-from ophyd_async.core import AsyncStatus, StandardReadable
+from ophyd_async.core import AsyncStatus, StandardReadable, StandardReadableFormat
 from ophyd_async.epics.core import epics_signal_r
 
-from dodal.devices.hutch_shutter import HutchShutter, ShutterDemand
+from dodal.devices.hutch_shutter import ShutterDemand, ShutterState
+from dodal.devices.i19.hutch_access import ACCESS_DEVICE_NAME
 from dodal.log import LOGGER
 
-
-class HutchInvalidError(Exception):
-    pass
+OPTICS_BLUEAPI_URL = "https://i19-blueapi.diamond.ac.uk"
 
 
 class HutchState(str, Enum):
     EH1 = "EH1"
     EH2 = "EH2"
-    INVALID = "INVALID"
 
 
-class HutchConditionalShutter(StandardReadable, Movable[ShutterDemand]):
+class AccessControlledShutter(StandardReadable, Movable[ShutterDemand]):
     """ I19-specific device to operate the hutch shutter.
 
-    This device evaluates the hutch state value to work out which of the two I19 \
-    hutches is in use and then implements the HutchShutter device to operate the \
-    experimental shutter.
+    This device will send a REST call to the blueapi instance controlling the optics \
+    hutch running on the I19 cluster, which will evaluate the current hutch in use vs \
+    the hutch sending the request and decide if the plan will be run or not.
     As the two hutches are located in series, checking the hutch in use is necessary to \
     avoid accidentally operating the shutter from one hutch while the other has beamtime.
 
-    The hutch name should be passed to the device upon instantiation. If this does not \
-    coincide with the current hutch in use, a warning will be logged and the shutter \
-    will not be operated. This is to allow for testing of plans.
-    An error will instead be raised if the hutch state reads as "INVALID".
+    The name of the hutch that wants to operate the shutter should be passed to the \
+    device upon instantiation.
+
+    For details see the architecture described in \
+    https://github.com/DiamondLightSource/i19-bluesky/issues/30.
     """
 
     def __init__(self, prefix: str, hutch: HutchState, name: str = "") -> None:
-        self.shutter = HutchShutter(prefix=prefix, name=name)
-        bl_prefix = prefix.split("-")[0]
-        self.hutch_state = epics_signal_r(str, f"{bl_prefix}-OP-STAT-01:EHStatus.VALA")
-        if hutch == HutchState.INVALID:
-            raise HutchInvalidError(
-                "Cannot define experimental shutter for invalid hutch"
-            )
+        with self.add_children_as_readables(StandardReadableFormat.HINTED_SIGNAL):
+            self.shutter_status = epics_signal_r(ShutterState, f"{prefix}STA")
         self.hutch_request = hutch
+        self.url = OPTICS_BLUEAPI_URL
         super().__init__(name)
 
     @AsyncStatus.wrap
     async def set(self, value: ShutterDemand):
-        hutch_in_use = await self.hutch_state.get_value()
-        LOGGER.info(f"Current hutch in use: {hutch_in_use}")
-        if hutch_in_use == HutchState.INVALID:
-            raise HutchInvalidError(
-                "The hutch state is invalid. Contact the beamline staff."
-            )
-        if hutch_in_use != self.hutch_request:
-            # NOTE Warn but don't fail
-            LOGGER.warning(
-                f"{self.hutch_request} is not the hutch in use. Shutter will not be operated."
-            )
-        else:
-            await self.shutter.set(value)
+        REQUEST_PARAMS = {
+            "name": "operate_shutter_plan",
+            "params": {
+                "experiment_hutch": self.hutch_request.value,
+                "access_device": ACCESS_DEVICE_NAME,
+                "shutter_demand": value,
+            },
+        }
+        async with ClientSession(base_url=self.url, raise_for_status=True) as session:
+            # First submit the plan to the worker
+            async with session.post("/tasks", data=REQUEST_PARAMS) as response:
+                LOGGER.debug(
+                    f"Task submitted to the worker, response status: {response.status}"
+                )
+
+                try:
+                    data = await response.json()
+                    task_id = data["task_id"]
+                except Exception as e:
+                    LOGGER.error(
+                        f"Failed to get task_id from {self.url}/tasks POST. ({e})"
+                    )
+                    raise
+            # Then set the task as active and run asap
+            async with session.put(
+                "/worker/tasks", data={"task_id": task_id}
+            ) as response:
+                if not response.ok:
+                    LOGGER.error(
+                        f"""Unable to operate the shutter.
+                        Session PUT responded with {response.status}: {response.reason}.
+                        """
+                    )
+                    return
+                LOGGER.debug(f"Run operate shutter plan, task_id: {task_id}")