Fixes #1787 Add I19 filter wheel selections (#1954)

* Fixes #1787 Add I19 filter wheel selections

* Add filter wheel with all six indexed positions

* Changes requested in code review

Author: CoePaul

src/dodal/beamlines/i19_optics.py

@@ -1,7 +1,11 @@
+from ophyd_async.epics.motor import Motor
+
 from dodal.common.beamlines.beamline_utils import (
     set_beamline as set_utils_beamline,
 )
 from dodal.device_manager import DeviceManager
+from dodal.devices.attenuator.filter import FilterWheel
+from dodal.devices.attenuator.filter_selections import I19FilterOneSelections
 from dodal.devices.beamlines.i19.access_controlled.hutch_access import (
     ACCESS_DEVICE_NAME,
     HutchAccessControl,
@@ -20,32 +24,119 @@
 
 
 @devices.factory()
-def shutter() -> InterlockedHutchShutter:
-    """Real experiment shutter device for I19."""
-    return InterlockedHutchShutter(
-        PREFIX.beamline_prefix, HutchInterlock(PREFIX.beamline_prefix)
-    )
+def access_control() -> HutchAccessControl:
+    """Device factory for access control device.
 
+    I19 features two experimental hutches, EH-1 and EH-2,
+    longitudinally positioned downstream from the common optics hutch:
+    Only one active EH can control the optics.
+    This device checks which EH is the active hutch.
 
-@devices.factory()
-def access_control() -> HutchAccessControl:
-    """Device to check which hutch is the active hutch on i19."""
+    Uses:
+        I19 beamline prefix extended with an infix specific to the access control.
+        Name of the access device in i19-blueapi.
+    """
     return HutchAccessControl(
         f"{PREFIX.beamline_prefix}-OP-STAT-01:", ACCESS_DEVICE_NAME
     )
 
 
 @devices.factory()
-def vfm() -> FocusingMirrorWithPiezo:
-    """Get the i19 vfm device, instantiate it if it hasn't already been.
-    If this is called when already instantiated, it will return the existing object.
+def attenuator_x_motor() -> Motor:
+    """Device factory for the I19 attenuator x-axis motor.
+
+    The x-axis linear motor drives an absorber wedge horizontally orthogonal to the x-ray beam.
+
+    Uses:
+        Prefix for the I19 beamline extended with an infix specific to the attenuator x-axis motor.
+        Name of the attenuator system x-axis motor device.
+
+    Returns:
+        Device for the x-axis attenuation system motor.
     """
-    return FocusingMirrorWithPiezo(f"{PREFIX.beamline_prefix}-OP-VFM-01:")
+    return Motor(f"{PREFIX.beamline_prefix}-OP-ATTN-04:X", "attenuator_x")
+
+
+@devices.factory()
+def attenuator_y_motor() -> Motor:
+    """Device factory for the I19 attenuator y-axis motor.
+
+    The y-axis linear motor drives an absorber wedge vertically orthogonal to the x-ray beam.
+
+    Uses:
+        Prefix for the I19 beamline extended with an infix specific to the attenuator y-axis motor.
+        Name of the attenuator system y-axis motor device.
+
+    Returns:
+        Device for the y-axis attenuation system motor.
+    """
+    return Motor(f"{PREFIX.beamline_prefix}-OP-ATTN-05:Y", "attenuator_y")
+
+
+@devices.factory()
+def filter_wheel() -> FilterWheel:
+    """Device factory for the I19 EH-1 filter wheel indexing motor.
+
+    Filter wheel motor rotates indexed wheel to bring specific attenuating filter into/out of x-ray beam.
+
+    Uses:
+        Beamline prefix for I19 extended with infix specific to the filter motor.
+        A further infix specific to filter wheel usage.
+        Name of the first filter wheel.
+
+    Returns:
+        First indexed filter wheel slot selecting rotation device.
+    """
+    return FilterWheel(
+        prefix=f"{PREFIX.beamline_prefix}-MO-FILT-01:",
+        filter_infix="FILTER",
+        filter_selections=I19FilterOneSelections,
+        name="filter_w_1",
+    )
 
 
 @devices.factory()
 def hfm() -> FocusingMirrorWithPiezo:
-    """Get the i19 hfm device, instantiate it if it hasn't already been.
-    If this is called when already instantiated, it will return the existing object.
+    """Device factory for the I19 Horizontal Focus Mirror (HFM) Piezo Device.
+
+    Lazy instantiation:  Instantiates a device object if none have been,
+    else it will return the pre-existing instance.
+
+    Uses:
+        I19 beamline prefix extended with an infix specific to the HFM.
+
+    Returns:
+         Focusing mirror piezo device for the HFM.
     """
     return FocusingMirrorWithPiezo(f"{PREFIX.beamline_prefix}-OP-HFM-01:")
+
+
+def shutter() -> InterlockedHutchShutter:
+    """Device factory for the I19 optics hutch shutter device.
+
+    Uses:
+        I19 beamline prefix extended with an infix specific to the optics hutch shutter.
+        HutchInterlock device (itself using I19 beamline prefix)
+
+    Returns:
+        I19 optics hutch shutter device.
+    """
+    return InterlockedHutchShutter(
+        PREFIX.beamline_prefix, HutchInterlock(PREFIX.beamline_prefix)
+    )
+
+
+@devices.factory()
+def vfm() -> FocusingMirrorWithPiezo:
+    """Device factory for the I19 Vertical Focus Mirror (VFM) Piezo Device.
+
+    Lazy instantiation:  Instantiates a device object if none have been,
+    else it will return the pre-existing instance.
+
+    Uses:
+        I19 beamline prefix with VFM infix.
+
+    Returns:
+         Focusing mirror piezo device for the VFM.
+    """
+    return FocusingMirrorWithPiezo(f"{PREFIX.beamline_prefix}-OP-VFM-01:")

src/dodal/devices/attenuator/filter.py

@@ -1,4 +1,4 @@
-from ophyd_async.core import StandardReadable, SubsetEnum
+from ophyd_async.core import StandardReadable, StrictEnum, SubsetEnum
 from ophyd_async.epics.core import epics_signal_rw
 
 
@@ -12,3 +12,21 @@ def __init__(
                 int, f"{prefix}DMOV"
             )  # 1 for yes, 0 for no
         super().__init__(name=name)
+
+
+class FilterWheel(StandardReadable):
+    def __init__(
+        self,
+        prefix: str,
+        filter_infix: str,
+        filter_selections: type[StrictEnum | SubsetEnum],
+        name: str = "",
+    ):
+        filter_prefix: str = f"{prefix}{filter_infix}"
+        with self.add_children_as_readables():
+            self.user_setpoint = epics_signal_rw(
+                datatype=filter_selections,
+                read_pv=filter_prefix,
+                write_pv=filter_prefix,
+            )
+        super().__init__(name=name)

src/dodal/devices/attenuator/filter_selections.py

@@ -1,4 +1,4 @@
-from ophyd_async.core import SubsetEnum
+from ophyd_async.core import StrictEnum, SubsetEnum
 
 
 class P99FilterSelections(SubsetEnum):
@@ -72,6 +72,15 @@ class I02_1FilterFourSelections(SubsetEnum):  # noqa: N801
     TI500 = "Ti500"
 
 
+class I19FilterOneSelections(StrictEnum):
+    AIR1 = "1 - "
+    AL = "2 - Al"
+    AIR3 = "3 - "
+    AU = "4 - Au"
+    AIR5 = "5 - "
+    FE = "6 - Fe"
+
+
 class I24FilterOneSelections(SubsetEnum):
     EMPTY = "Empty"
     AL12_5 = "Al12.5"