Restructured insertion device logic ready for daq-config-server (#1746)

* Restructured insertion device code base

* Reused logic between tests

* Rename get_poly arg to be lut

* Added additional tests for energy_motor_lookup and lookup_table_models

* Created common util functions for tests

* Fix tests

* Added test for ConfigServerEnergyMotorLookup

* Remove content from insetion device __init__ as not used

* Removed comment

* Correct import

* Correct doc strings

* Move model methods onto the class

* Improved test_lookup_table_generate

* Further streamlined test_lookup_table_generate

* Reorded tests

* More test improvements

* Correct LookupTable.generate doc string

* Add type checking to validate_and_convert_poly

Author: oliwenmandiamond

src/dodal/beamlines/i05.py

@@ -3,7 +3,7 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     UndulatorGap,
     UndulatorLockedPhaseAxes,

src/dodal/beamlines/i06.py

@@ -2,7 +2,7 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     UndulatorGap,
     UndulatorLockedPhaseAxes,

src/dodal/beamlines/i09_2.py

@@ -6,26 +6,26 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
+from dodal.devices.i09.enums import Grating
+from dodal.devices.i09_2_shared.i09_apple2 import (
+    J09_GAP_POLY_DEG_COLUMNS,
+    J09_PHASE_POLY_DEG_COLUMNS,
+    J09Apple2Controller,
+)
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     BeamEnergy,
     InsertionDeviceEnergy,
     InsertionDevicePolarisation,
     UndulatorGap,
     UndulatorPhaseAxes,
 )
-from dodal.devices.i09.enums import Grating
-from dodal.devices.i09_2_shared.i09_apple2 import (
-    J09_GAP_POLY_DEG_COLUMNS,
-    J09_PHASE_POLY_DEG_COLUMNS,
-    J09Apple2Controller,
+from dodal.devices.insertion_device.energy_motor_lookup import (
+    ConfigServerEnergyMotorLookup,
 )
+from dodal.devices.insertion_device.lookup_table_models import LookupTableConfig
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.util.lookup_tables_apple2 import (
-    ConfigServerEnergyMotorLookup,
-    LookupTableConfig,
-)
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 

src/dodal/beamlines/i10_optics.py

@@ -12,14 +12,6 @@
 
 from dodal.common.beamlines.beamline_utils import device_factory
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
-    BeamEnergy,
-    InsertionDeviceEnergy,
-    InsertionDevicePolarisation,
-    UndulatorGap,
-    UndulatorJawPhase,
-    UndulatorPhaseAxes,
-)
 from dodal.devices.i10 import (
     I10SharedDiagnostic,
     I10SharedSlits,
@@ -34,14 +26,24 @@
 
 # Imports taken from i10 while we work out how to deal with split end stations
 from dodal.devices.i10.i10_setting_data import I10Grating
-from dodal.devices.pgm import PlaneGratingMonochromator
-from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.util.lookup_tables_apple2 import (
+from dodal.devices.insertion_device.apple2_undulator import (
+    BeamEnergy,
+    InsertionDeviceEnergy,
+    InsertionDevicePolarisation,
+    UndulatorGap,
+    UndulatorJawPhase,
+    UndulatorPhaseAxes,
+)
+from dodal.devices.insertion_device.energy_motor_lookup import (
+    ConfigServerEnergyMotorLookup,
+)
+from dodal.devices.insertion_device.lookup_table_models import (
     DEFAULT_GAP_FILE,
     DEFAULT_PHASE_FILE,
-    ConfigServerEnergyMotorLookup,
     LookupTableConfig,
 )
+from dodal.devices.pgm import PlaneGratingMonochromator
+from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 

src/dodal/beamlines/i17.py

@@ -7,7 +7,8 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
+from dodal.devices.i17.i17_apple2 import I17Apple2Controller
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     Apple2Controller,
     BeamEnergy,
@@ -16,13 +17,10 @@
     UndulatorGap,
     UndulatorPhaseAxes,
 )
-from dodal.devices.i17.i17_apple2 import I17Apple2Controller
+from dodal.devices.insertion_device.energy_motor_lookup import EnergyMotorLookup
+from dodal.devices.insertion_device.lookup_table_models import LookupTable
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
-from dodal.devices.util.lookup_tables_apple2 import (
-    EnergyMotorLookup,
-    LookupTable,
-)
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 

src/dodal/beamlines/i21.py

@@ -2,12 +2,12 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.apple2_undulator import (
+from dodal.devices.i21 import Grating
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     UndulatorGap,
     UndulatorPhaseAxes,
 )
-from dodal.devices.i21 import Grating
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline

src/dodal/devices/i09_2_shared/i09_apple2.py

@@ -1,4 +1,4 @@
-from dodal.devices.apple2_undulator import (
+from dodal.devices.insertion_device.apple2_undulator import (
     MAXIMUM_MOVE_TIME,
     Apple2,
     Apple2Controller,
@@ -7,7 +7,7 @@
     Pol,
     UndulatorPhaseAxes,
 )
-from dodal.devices.util.lookup_tables_apple2 import EnergyMotorLookup
+from dodal.devices.insertion_device.energy_motor_lookup import EnergyMotorLookup
 
 J09_GAP_POLY_DEG_COLUMNS = [
     "9th-order",

src/dodal/devices/i10/i10_apple2.py

@@ -11,7 +11,7 @@
     soft_signal_rw,
 )
 
-from dodal.devices.apple2_undulator import (
+from dodal.devices.insertion_device.apple2_undulator import (
     MAXIMUM_MOVE_TIME,
     Apple2,
     Apple2Controller,
@@ -22,7 +22,7 @@
     UndulatorJawPhase,
     UndulatorPhaseAxes,
 )
-from dodal.devices.util.lookup_tables_apple2 import EnergyMotorLookup
+from dodal.devices.insertion_device.energy_motor_lookup import EnergyMotorLookup
 
 ROW_PHASE_MOTOR_TOLERANCE = 0.004
 MAXIMUM_ROW_PHASE_MOTOR_POSITION = 24.0

src/dodal/devices/i17/i17_apple2.py

@@ -1,12 +1,12 @@
-from dodal.devices.apple2_undulator import (
+from dodal.devices.insertion_device.apple2_undulator import (
     Apple2,
     Apple2Controller,
     Apple2PhasesVal,
     Apple2Val,
     Pol,
     UndulatorPhaseAxes,
 )
-from dodal.devices.util.lookup_tables_apple2 import EnergyMotorLookup
+from dodal.devices.insertion_device.energy_motor_lookup import EnergyMotorLookup
 
 ROW_PHASE_MOTOR_TOLERANCE = 0.004
 MAXIMUM_ROW_PHASE_MOTOR_POSITION = 24.0