Created common enums and updated devices to use (#1415)

* Created common enums and updated devices to use

* Corrected backlight OnOff

* Switched ordering of enums

* Correct spelling

* Updated remaining enums that have extra options

* Renamed InOut to InState

* Updated to use enums from ophyd-async

* Renamed enums to Upper

* test

* Restore previous whitespace formatting

* Updated enums reusing ones from ophyd-async to use .value, same as ophyd-async

---------

Co-authored-by: Joseph Ware <53935796+DiamondJoseph@users.noreply.github.com>

Author: oliwenmandiamond

src/dodal/beamlines/i23.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from ophyd_async.core import StrictEnum
+from ophyd_async.core import InOut, StrictEnum
 from ophyd_async.epics.adpilatus import PilatusDetector
 
 from dodal.common.beamlines.beamline_utils import (
@@ -45,8 +45,8 @@
 
 
 class I23DetectorPositions(StrictEnum):
-    IN = "In"
-    OUT = "Out"
+    IN = InOut.IN.value
+    OUT = InOut.OUT.value
     SAMPLE_CHANGE = "sample change"
 
 

src/dodal/common/__init__.py

@@ -1,10 +1,14 @@
 from .coordination import group_uuid, inject
+from .enums import EnabledDisabledUpper, InOutUpper, OnOffUpper
 from .maths import in_micros, step_to_num
 from .types import MsgGenerator, PlanGenerator
 
 __all__ = [
     "group_uuid",
     "inject",
+    "EnabledDisabledUpper",
+    "InOutUpper",
+    "OnOffUpper",
     "in_micros",
     "MsgGenerator",
     "PlanGenerator",

src/dodal/common/enums.py

@@ -0,0 +1,19 @@
+from ophyd_async.core import StrictEnum
+
+# Any capitalised enums needs to be removed and replaced with ones from ophyd-async.core
+# https://github.com/DiamondLightSource/dodal/issues/1416
+
+
+class OnOffUpper(StrictEnum):
+    ON = "ON"
+    OFF = "OFF"
+
+
+class EnabledDisabledUpper(StrictEnum):
+    ENABLED = "ENABLED"
+    DISABLED = "DISABLED"
+
+
+class InOutUpper(StrictEnum):
+    IN = "IN"
+    OUT = "OUT"

src/dodal/devices/aithre_lasershaping/laser_robot.py

@@ -1,24 +1,19 @@
-from ophyd_async.core import StrictEnum
+from ophyd_async.core import EnabledDisabled, OnOff, StrictEnum
 from ophyd_async.epics.core import epics_signal_rw
 
 from dodal.devices.robot import BartRobot
 
 
 class ForceBit(StrictEnum):
-    ON = "On"
+    ON = OnOff.ON.value
     NO = "No"
-    OFF = "Off"
-
-
-class LidHeatEnable(StrictEnum):
-    ENABLED = "Enabled"
-    DISABLED = "Disabled"
+    OFF = OnOff.OFF.value
 
 
 class LaserRobot(BartRobot):
     def __init__(self, prefix: str, name: str = "") -> None:
         self.dewar_lid_heater = epics_signal_rw(
-            LidHeatEnable, prefix + "DW_1_ENABLED", prefix + "DW_1_CTRL"
+            EnabledDisabled, prefix + "DW_1_ENABLED", prefix + "DW_1_CTRL"
         )
         self.cryojet_retract = epics_signal_rw(ForceBit, prefix + "OP_24_FORCE_OPTION")
         self.set_beamline_safe = epics_signal_rw(

src/dodal/devices/backlight.py

@@ -1,35 +1,23 @@
 from asyncio import sleep
 
 from bluesky.protocols import Movable
-from ophyd_async.core import AsyncStatus, StandardReadable, StrictEnum
+from ophyd_async.core import AsyncStatus, InOut, OnOff, StandardReadable
 from ophyd_async.epics.core import epics_signal_rw
 
 
-class BacklightPower(StrictEnum):
-    ON = "On"
-    OFF = "Off"
-
-
-class BacklightPosition(StrictEnum):
-    IN = "In"
-    OUT = "Out"
-
-
-class Backlight(StandardReadable, Movable[BacklightPosition]):
+class Backlight(StandardReadable, Movable[InOut]):
     """Simple device to trigger the pneumatic in/out."""
 
     TIME_TO_MOVE_S = 1.0  # Tested using a stopwatch on the beamline 09/2024
 
     def __init__(self, prefix: str, name: str = "") -> None:
         with self.add_children_as_readables():
-            self.power = epics_signal_rw(BacklightPower, prefix + "-EA-BLIT-01:TOGGLE")
-            self.position = epics_signal_rw(
-                BacklightPosition, prefix + "-EA-BL-01:CTRL"
-            )
+            self.power = epics_signal_rw(OnOff, prefix + "-EA-BLIT-01:TOGGLE")
+            self.position = epics_signal_rw(InOut, prefix + "-EA-BL-01:CTRL")
         super().__init__(name)
 
     @AsyncStatus.wrap
-    async def set(self, value: BacklightPosition):
+    async def set(self, value: InOut):
         """This setter will turn the backlight on when we move it in to the beam and off
         when we move it out.
 
@@ -39,9 +27,9 @@ async def set(self, value: BacklightPosition):
         """
         old_position = await self.position.get_value()
         await self.position.set(value)
-        if value == BacklightPosition.OUT:
-            await self.power.set(BacklightPower.OFF)
+        if value == InOut.OUT:
+            await self.power.set(OnOff.OFF)
         else:
-            await self.power.set(BacklightPower.ON)
+            await self.power.set(OnOff.ON)
         if old_position != value:
             await sleep(self.TIME_TO_MOVE_S)

src/dodal/devices/bimorph_mirror.py

@@ -22,12 +22,9 @@
     epics_signal_x,
 )
 
-DEFAULT_TIMEOUT = 60
-
+from dodal.common.enums import OnOffUpper
 
-class BimorphMirrorOnOff(StrictEnum):
-    ON = "ON"
-    OFF = "OFF"
+DEFAULT_TIMEOUT = 60
 
 
 class BimorphMirrorMode(StrictEnum):
@@ -54,7 +51,7 @@ class BimorphMirrorChannel(StandardReadable, EpicsDevice):
 
     target_voltage: A[SignalRW[float], PvSuffix.rbv("VTRGT"), Format.CONFIG_SIGNAL]
     output_voltage: A[SignalRW[float], PvSuffix.rbv("VOUT"), Format.HINTED_SIGNAL]
-    status: A[SignalR[BimorphMirrorOnOff], PvSuffix("STATUS"), Format.CONFIG_SIGNAL]
+    status: A[SignalR[OnOffUpper], PvSuffix("STATUS"), Format.CONFIG_SIGNAL]
     shift: A[SignalW[float], PvSuffix("SHIFT")]
 
 
@@ -87,7 +84,7 @@ def __init__(self, prefix: str, number_of_channels: int, name=""):
                     for i in range(1, number_of_channels + 1)
                 }
             )
-        self.enabled = epics_signal_w(BimorphMirrorOnOff, f"{prefix}ONOFF")
+        self.enabled = epics_signal_w(OnOffUpper, f"{prefix}ONOFF")
         self.commit_target_voltages = epics_signal_x(f"{prefix}ALLTRGT.PROC")
         self.status = epics_signal_r(BimorphMirrorStatus, f"{prefix}STATUS")
         self.err = epics_signal_r(str, f"{prefix}ERR")

src/dodal/devices/cryostream.py

@@ -1,12 +1,7 @@
-from ophyd_async.core import StandardReadable, StrictEnum
+from ophyd_async.core import InOut, StandardReadable
 from ophyd_async.epics.core import epics_signal_r, epics_signal_rw
 
 
-class InOut(StrictEnum):
-    IN = "In"
-    OUT = "Out"
-
-
 class CryoStream(StandardReadable):
     MAX_TEMP_K = 110
     MAX_PRESSURE_BAR = 0.1
@@ -18,5 +13,4 @@ def __init__(self, prefix: str, name: str = ""):
         self.back_pressure_bar = epics_signal_r(
             float, f"{prefix}-EA-CSTRM-01:BACKPRESS"
         )
-
         super().__init__(name)

src/dodal/devices/fluorescence_detector_motion.py

@@ -1,12 +1,7 @@
-from ophyd_async.core import StandardReadable, StrictEnum
+from ophyd_async.core import InOut, StandardReadable
 from ophyd_async.epics.core import epics_signal_rw
 
 
-class InOut(StrictEnum):
-    OUT = "Out"
-    IN = "In"
-
-
 class FluorescenceDetector(StandardReadable):
     def __init__(self, prefix: str, name: str = ""):
         with self.add_children_as_readables():

src/dodal/devices/i10/diagnostics.py

@@ -54,13 +54,13 @@ class D7Position(StrictEnum):
     SHUTTER = "Shutter"
 
 
-class InOutTable(StrictEnum):
+class InStateTable(StrictEnum):
     MOVE_IN = "Move In"
     MOVE_OUT = "Move Out"
     RESET = "Reset"
 
 
-class InOutReadBackTable(StrictEnum):
+class InStateReadBackTable(StrictEnum):
     MOVE_IN = "Moving In"
     MOVE_OUT = "Moving Out"
     IN_BEAM = "In Beam"
@@ -80,11 +80,11 @@ def __init__(
     ) -> None:
         with self.add_children_as_readables(Format.HINTED_SIGNAL):
             self.stage_position_set = epics_signal_rw(
-                InOutTable,
+                InStateTable,
                 read_pv=prefix + "CON",
             )
             self.stage_position_readback = epics_signal_r(
-                InOutReadBackTable,
+                InStateReadBackTable,
                 read_pv=prefix + "STA",
             )
         super().__init__(name=name)

src/dodal/devices/i22/fswitch.py

@@ -7,20 +7,11 @@
     DeviceVector,
     StandardReadable,
     StandardReadableFormat,
-    StrictEnum,
     soft_signal_r_and_setter,
 )
 from ophyd_async.epics.core import epics_signal_r
 
-
-class FilterState(StrictEnum):
-    """
-    Note that the in/out here refers to the internal rocker
-    position so a PV value of IN implies a filter OUT of beam
-    """
-
-    IN_BEAM = "OUT"
-    OUT_BEAM = "IN"
+from dodal.common.enums import InOutUpper
 
 
 class FSwitch(StandardReadable):
@@ -50,7 +41,7 @@ def __init__(
     ) -> None:
         self.filters = DeviceVector(
             {
-                i: epics_signal_r(FilterState, f"{prefix}FILTER-{i:03}:STATUS_RBV")
+                i: epics_signal_r(InOutUpper, f"{prefix}FILTER-{i:03}:STATUS_RBV")
                 for i in range(FSwitch.NUM_FILTERS)
             }
         )
@@ -91,7 +82,7 @@ async def read(self) -> dict[str, Reading]:
         result = await asyncio.gather(
             *(filter.get_value() for filter in self.filters.values())
         )
-        num_in = sum(r.value == FilterState.IN_BEAM for r in result)
+        num_in = sum(r.value == InOutUpper.IN for r in result)
         default_reading = await super().read()
         return {
             FSwitch.NUM_LENSES_FIELD_NAME: Reading(value=num_in, timestamp=time.time()),