Create common mirror classes and populate I05s mirrors (#1418)

* create i05-shared and move pgm there

* change names to snake case

* minor import change

* create base mirror

* add m1 mirror

* add XY and XYZ collimating mirrrors

* fix i10

* add piezo mirror

* add more mirrors

* move i05-shared to beamline specific utils

* amend beamlines init file

* move i05-shared to beamline specific utils

* amend beamlines init file

* remove XY coll mirror - will be a separate issue

* rename mirror class

* move xyzpitchyawroll to motors

* rename pgm

* add explicit parameters to child classes

* make common mirror classes generic of strictenum

* add mirrors controls and docstring

* make all new classes depend on Stage only

* relocate common_mirror to I05 devices

* add comment on mirrors connection

* make mirrors locatable and stoppable, fix typos

* fix merge

* fix merge

* fix test

* complete merge with main

* move common_mirror level up

* replace i10 PiezoMirror with XYZPiezoCollimatingMirror

* make XYZSwitchingMirror parent of XYZPiezoSwitchingMirror

* fix merge lint errors

* finish merge with main

* added docstrings, extract constant suffix

* fix lint

* fix lint

---------

Co-authored-by: eir17846 <victor.rogalev@diamond.ac.uk>

Author: Villtord

src/dodal/beamlines/i05.py

@@ -2,6 +2,8 @@
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager
 from dodal.devices.beamlines.i05 import I05Goniometer
+from dodal.devices.beamlines.i05_shared import M4M5Mirror
+from dodal.devices.common_mirror import XYZSwitchingMirror
 from dodal.devices.hutch_shutter import HutchShutter
 from dodal.devices.temperture_controller import Lakeshore336
 from dodal.log import set_beamline as set_log_beamline
@@ -16,6 +18,15 @@
 devices.include(i05_shared_devices)
 
 
+# will connect after https://jira.diamond.ac.uk/browse/I05-731
+@devices.factory(skip=True)
+def m4m5() -> XYZSwitchingMirror:
+    return XYZSwitchingMirror(
+        prefix=f"{PREFIX.beamline_prefix}-OP-RFM-01:",
+        mirrors=M4M5Mirror,
+    )
+
+
 @devices.factory()
 def hr_shutter() -> HutchShutter:
     return HutchShutter(PREFIX.beamline_prefix)

src/dodal/beamlines/i05_1.py

@@ -2,6 +2,8 @@
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager
 from dodal.devices.beamlines.i05_1 import XYZAzimuthPolarDefocusStage
+from dodal.devices.beamlines.i05_shared import Mj7j8Mirror
+from dodal.devices.common_mirror import XYZPiezoSwitchingMirror
 from dodal.devices.hutch_shutter import HutchShutter
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -15,6 +17,15 @@
 devices.include(i05_shared_devices)
 
 
+# will connect after https://jira.diamond.ac.uk/browse/I05-731
+@devices.factory(skip=True)
+def mj7j8() -> XYZPiezoSwitchingMirror:
+    return XYZPiezoSwitchingMirror(
+        prefix=f"{PREFIX.beamline_prefix}-OP-RFM-01:",
+        mirrors=Mj7j8Mirror,
+    )
+
+
 @devices.factory()
 def nano_shutter() -> HutchShutter:
     return HutchShutter(PREFIX.beamline_prefix)

src/dodal/beamlines/i05_shared.py

@@ -2,9 +2,11 @@
 from dodal.devices.beamlines.i05_shared import (
     APPLE_KNOT_EXCLUSION_ZONES,
     Grating,
+    M3MJ6Mirror,
     energy_to_gap_converter,
     energy_to_phase_converter,
 )
+from dodal.devices.common_mirror import XYZPiezoSwitchingMirror
 from dodal.devices.insertion_device import (
     Apple2,
     UndulatorGap,
@@ -16,6 +18,7 @@
 )
 from dodal.devices.insertion_device.energy import BeamEnergy, InsertionDeviceEnergy
 from dodal.devices.insertion_device.polarisation import InsertionDevicePolarisation
+from dodal.devices.motors import XYZPitchYawRollStage
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -62,6 +65,20 @@ def id(
     return Apple2[UndulatorLockedPhaseAxes](id_gap=id_gap, id_phase=id_phase)
 
 
+@devices.factory()
+def m1_collimating_mirror() -> XYZPitchYawRollStage:
+    return XYZPitchYawRollStage(prefix=f"{PREFIX.beamline_prefix}-OP-COL-01:")
+
+
+# will connect after https://jira.diamond.ac.uk/browse/I05-731
+@devices.factory(skip=True)
+def m3mj6_switching_mirror() -> XYZPiezoSwitchingMirror:
+    return XYZPiezoSwitchingMirror(
+        prefix=f"{PREFIX.beamline_prefix}-OP-SWTCH-01:",
+        mirrors=M3MJ6Mirror,
+    )
+
+
 @devices.factory()
 def id_controller(
     id: Apple2[UndulatorLockedPhaseAxes],

src/dodal/beamlines/i10.py

@@ -6,7 +6,6 @@
     I10Diagnostic5ADet,
     I10Slits,
     I10SlitsDrainCurrent,
-    PiezoMirror,
 )
 from dodal.devices.beamlines.i10.diagnostics import I10Diagnostic, I10Diagnostic5ADet
 from dodal.devices.beamlines.i10.rasor.rasor_current_amp import RasorFemto, RasorSR570
@@ -16,6 +15,7 @@
     PaStage,
 )
 from dodal.devices.beamlines.i10.rasor.rasor_scaler_cards import RasorScalerCard1
+from dodal.devices.common_mirror import XYZPiezoCollimatingMirror
 from dodal.devices.current_amplifiers import CurrentAmpDet
 from dodal.devices.motors import XYStage, XYZStage
 from dodal.devices.temperture_controller import (
@@ -34,8 +34,8 @@
 
 
 @devices.factory()
-def focusing_mirror() -> PiezoMirror:
-    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCS-01:")
+def focusing_mirror() -> XYZPiezoCollimatingMirror:
+    return XYZPiezoCollimatingMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCS-01:")
 
 
 """Optic slits"""

src/dodal/beamlines/i10_1.py

@@ -1,12 +1,13 @@
 from dodal.beamlines.i10_shared import devices as i10_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager
-from dodal.devices.beamlines.i10 import I10JDiagnostic, I10JSlits, PiezoMirror
+from dodal.devices.beamlines.i10 import I10JDiagnostic, I10JSlits
 from dodal.devices.beamlines.i10_1 import (
     ElectromagnetMagnetField,
     ElectromagnetStage,
     I10JScalerCard,
 )
+from dodal.devices.common_mirror import XYZPiezoCollimatingMirror
 from dodal.devices.current_amplifiers import (
     SR570,
     CurrentAmpDet,
@@ -57,8 +58,8 @@ def diagnostic() -> I10JDiagnostic:
 
 
 @devices.factory()
-def focusing_mirror() -> PiezoMirror:
-    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCA-01:")
+def focusing_mirror() -> XYZPiezoCollimatingMirror:
+    return XYZPiezoCollimatingMirror(prefix=f"{PREFIX.beamline_prefix}-OP-FOCA-01:")
 
 
 """I10J Electromagnet Devices"""

src/dodal/beamlines/i10_shared.py

@@ -15,7 +15,6 @@
     I10SharedDiagnostic,
     I10SharedSlits,
     I10SharedSlitsDrainCurrent,
-    PiezoMirror,
 )
 from dodal.devices.beamlines.i10.i10_apple2 import (
     I10Apple2,
@@ -25,6 +24,7 @@
 
 # Imports taken from i10 while we work out how to deal with split end stations
 from dodal.devices.beamlines.i10.i10_setting_data import I10Grating
+from dodal.devices.common_mirror import XYZPiezoCollimatingMirror
 from dodal.devices.insertion_device import (
     BeamEnergy,
     InsertionDeviceEnergy,
@@ -63,8 +63,8 @@ def synchrotron() -> Synchrotron:
 
 
 @devices.factory()
-def first_mirror() -> PiezoMirror:
-    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-COL-01:")
+def first_mirror() -> XYZPiezoCollimatingMirror:
+    return XYZPiezoCollimatingMirror(prefix=f"{PREFIX.beamline_prefix}-OP-COL-01:")
 
 
 @devices.factory()
@@ -80,8 +80,8 @@ def pgm() -> PlaneGratingMonochromator:
 
 
 @devices.factory()
-def switching_mirror() -> PiezoMirror:
-    return PiezoMirror(prefix=f"{PREFIX.beamline_prefix}-OP-SWTCH-01:")
+def switching_mirror() -> XYZPiezoCollimatingMirror:
+    return XYZPiezoCollimatingMirror(prefix=f"{PREFIX.beamline_prefix}-OP-SWTCH-01:")
 
 
 """ID"""

src/dodal/devices/beamlines/i05/__init__.py

@@ -1,3 +1,5 @@
 from .i05_motors import I05Goniometer
 
-__all__ = ["I05Goniometer"]
+__all__ = [
+    "I05Goniometer",
+]

src/dodal/devices/beamlines/i05_shared/__init__.py

@@ -4,10 +4,18 @@
     energy_to_phase_converter,
 )
 from dodal.devices.beamlines.i05_shared.compound_motors import PolynomCompoundMotors
-from dodal.devices.beamlines.i05_shared.enums import Grating
+from dodal.devices.beamlines.i05_shared.enums import (
+    Grating,
+    M3MJ6Mirror,
+    M4M5Mirror,
+    Mj7j8Mirror,
+)
 
 __all__ = [
     "Grating",
+    "Mj7j8Mirror",
+    "M3MJ6Mirror",
+    "M4M5Mirror",
     "PolynomCompoundMotors",
     "energy_to_gap_converter",
     "energy_to_phase_converter",

src/dodal/devices/beamlines/i05_shared/enums.py

@@ -6,3 +6,24 @@ class Grating(StrictEnum):
     C_1600 = "C 1600 lines/mm"
     RH_1600 = "Rh 1600 lines/mm"
     PT_800 = "B 800 lines/mm"
+
+
+class M3MJ6Mirror(StrictEnum):
+    UNKNOWN = "Unknown"
+    MJ6 = "MJ6"
+    M3 = "M3"
+    REFERENCE = "Reference"
+
+
+class M4M5Mirror(StrictEnum):
+    UNKNOWN = "Unknown"
+    M4 = "M4"
+    M5 = "M5"
+    REFERENCE = "Reference"
+
+
+class Mj7j8Mirror(StrictEnum):
+    UNKNOWN = "Unknown"
+    MJ8 = "MJ8"
+    MJ7 = "MJ7"
+    REFERENCE = "Reference"

src/dodal/devices/beamlines/i10/__init__.py

@@ -5,7 +5,6 @@
     I10PneumaticStage,
     I10SharedDiagnostic,
 )
-from .mirrors import PiezoMirror
 from .slits import (
     I10JSlits,
     I10SharedSlits,
@@ -18,7 +17,6 @@
     "I10Diagnostic",
     "I10Diagnostic5ADet",
     "I10PneumaticStage",
-    "PiezoMirror",
     "I10Slits",
     "I10SlitsDrainCurrent",
     "I10SharedDiagnostic",