Use config server for OAV config files (#1748)

* Use config server for OAV config json

* Convert OAV test config files to json

* Read OAV config correctly

* Fix for github.com/DiamondLightSource/daq-config-server/pull/156

* Inject config client into OAVConfig and OAVConfigBeamCentre

* Rename test file

* Dont use get_beamline_parameters in device factories

* Fix tests

Author: jacob720

src/dodal/beamlines/aithre.py

@@ -1,3 +1,7 @@
+from functools import cache
+
+from daq_config_server import ConfigClient
+
 from dodal.device_manager import DeviceManager
 from dodal.devices.aithre_lasershaping.goniometer import Goniometer
 from dodal.devices.aithre_lasershaping.laser_robot import LaserRobot
@@ -14,6 +18,12 @@
 devices = DeviceManager()
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    return ConfigClient()
+
+
 @devices.factory()
 def goniometer() -> Goniometer:
     return Goniometer(
@@ -31,12 +41,16 @@ def robot() -> LaserRobot:
 
 
 @devices.factory()
-def oav(params: OAVConfigBeamCentre | None = None) -> OAVBeamCentreFile:
+def oav(
+    config_client: ConfigClient, params: OAVConfigBeamCentre | None = None
+) -> OAVBeamCentreFile:
     config = (
         params
         if params is not None
         else OAVConfigBeamCentre(
-            zoom_params_file=ZOOM_PARAMS_FILE, display_config_file=DISPLAY_CONFIG
+            zoom_params_file=ZOOM_PARAMS_FILE,
+            display_config_file=DISPLAY_CONFIG,
+            config_client=config_client,
         )
     )
     return OAVBeamCentreFile(

src/dodal/beamlines/i03.py

@@ -6,7 +6,6 @@
 from ophyd_async.fastcs.panda import HDFPanda
 from yarl import URL
 
-from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.beamlines.beamline_utils import set_config_client, set_path_provider
 from dodal.common.beamlines.commissioning_mode import set_commissioning_signal
@@ -69,6 +68,9 @@
     "/dls_sw/i03/software/gda/configurations/i03-config/xml/jCameraManZoomLevels.xml"
 )
 DISPLAY_CONFIG = "/dls_sw/i03/software/gda_versions/var/display.configuration"
+BEAMLINE_PARAMETERS_PATH = (
+    "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters"
+)
 DAQ_CONFIGURATION_PATH = "/dls_sw/i03/software/daq_configuration"
 I03_CONFIG_SERVER_ENDPOINT = "https://i03-daq-config.diamond.ac.uk"
 
@@ -108,8 +110,9 @@ def daq_configuration_path() -> str:
 
 
 @devices.factory()
-def aperture_scatterguard() -> ApertureScatterguard:
-    params = get_beamline_parameters(BL)
+def aperture_scatterguard(config_client: ConfigClient) -> ApertureScatterguard:
+    print(BEAMLINE_PARAMETERS_PATH)
+    params = config_client.get_file_contents(BEAMLINE_PARAMETERS_PATH, dict)
     return ApertureScatterguard(
         aperture_prefix=f"{PREFIX.beamline_prefix}-MO-MAPT-01:",
         scatterguard_prefix=f"{PREFIX.beamline_prefix}-MO-SCAT-01:",
@@ -127,10 +130,12 @@ def attenuator() -> BinaryFilterAttenuator:
 
 
 @devices.factory()
-def beamstop() -> Beamstop:
+def beamstop(config_client: ConfigClient) -> Beamstop:
     return Beamstop(
         prefix=f"{PREFIX.beamline_prefix}-MO-BS-01:",
-        beamline_parameters=get_beamline_parameters(BL),
+        beamline_parameters=config_client.get_file_contents(
+            BEAMLINE_PARAMETERS_PATH, dict
+        ),
     )
 
 
@@ -205,11 +210,13 @@ def panda_fast_grid_scan() -> PandAFastGridScan:
 
 @devices.factory()
 def oav(
+    config_client: ConfigClient,
     params: OAVConfigBeamCentre | None = None,
 ) -> OAVBeamCentreFile:
     return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        config=params or OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=params
+        or OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG, config_client),
     )
 
 
@@ -368,11 +375,13 @@ def fluorescence_det_motion() -> FluorescenceDetector:
 
 
 @devices.factory()
-def scintillator(aperture_scatterguard: ApertureScatterguard) -> Scintillator:
+def scintillator(
+    aperture_scatterguard: ApertureScatterguard, config_client: ConfigClient
+) -> Scintillator:
     return Scintillator(
         f"{PREFIX.beamline_prefix}-MO-SCIN-01:",
         Reference(aperture_scatterguard),
-        get_beamline_parameters(BL),
+        config_client.get_file_contents(BEAMLINE_PARAMETERS_PATH, dict),
     )
 
 

src/dodal/beamlines/i04.py

@@ -3,7 +3,6 @@
 from daq_config_server import ConfigClient
 from ophyd_async.core import Reference
 
-from dodal.common.beamlines.beamline_parameters import get_beamline_parameters
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.beamlines.beamline_utils import set_config_client
 from dodal.device_manager import DeviceManager
@@ -60,6 +59,9 @@
 # Use BlueAPI scratch until https://github.com/DiamondLightSource/mx-bluesky/issues/1097 is done
 ZOOM_PARAMS_FILE = "/dls_sw/i04/software/bluesky/scratch/jCameraManZoomLevels.xml"
 DISPLAY_CONFIG = "/dls_sw/i04/software/bluesky/scratch/display.configuration"
+BEAMLINE_PARAMETERS_PATH = (
+    "/dls_sw/i04/software/daq_configuration/domain/beamlineParameters"
+)
 DAQ_CONFIGURATION_PATH = "/dls_sw/i04/software/daq_configuration"
 I04_CONFIG_SERVER_ENDPOINT = "https://i04-daq-config.diamond.ac.uk"
 
@@ -108,10 +110,12 @@ def ipin() -> IPin:
 
 
 @devices.factory()
-def beamstop() -> Beamstop:
+def beamstop(config_client: ConfigClient) -> Beamstop:
     return Beamstop(
         f"{PREFIX.beamline_prefix}-MO-BS-01:",
-        beamline_parameters=get_beamline_parameters(BL),
+        beamline_parameters=config_client.get_file_contents(
+            BEAMLINE_PARAMETERS_PATH, dict
+        ),
     )
 
 
@@ -159,8 +163,8 @@ def backlight() -> Backlight:
 
 
 @devices.factory()
-def aperture_scatterguard() -> ApertureScatterguard:
-    params = get_beamline_parameters(BL)
+def aperture_scatterguard(config_client: ConfigClient) -> ApertureScatterguard:
+    params = config_client.get_file_contents(BEAMLINE_PARAMETERS_PATH, dict)
     return ApertureScatterguard(
         aperture_prefix=f"{PREFIX.beamline_prefix}-MO-MAPT-01:",
         scatterguard_prefix=f"{PREFIX.beamline_prefix}-MO-SCAT-01:",
@@ -216,18 +220,22 @@ def zebra() -> Zebra:
 
 
 @devices.factory()
-def oav(params: OAVConfig | None = None) -> OAVBeamCentrePV:
+def oav(
+    config_client: ConfigClient, params: OAVConfig | None = None
+) -> OAVBeamCentrePV:
     return OAVBeamCentrePV(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        config=params or OAVConfig(ZOOM_PARAMS_FILE),
+        config=params or OAVConfig(ZOOM_PARAMS_FILE, config_client),
     )
 
 
 @devices.factory()
-def oav_full_screen(params: OAVConfig | None = None) -> OAVBeamCentrePV:
+def oav_full_screen(
+    config_client: ConfigClient, params: OAVConfig | None = None
+) -> OAVBeamCentrePV:
     return OAVBeamCentrePV(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        config=params or OAVConfig(ZOOM_PARAMS_FILE),
+        config=params or OAVConfig(ZOOM_PARAMS_FILE, config_client),
         overlay_channel=3,
         mjpeg_prefix="XTAL",
     )
@@ -292,11 +300,13 @@ def pin_tip_detection() -> PinTipDetection:
 
 
 @devices.factory()
-def scintillator(aperture_scatterguard: ApertureScatterguard) -> Scintillator:
+def scintillator(
+    aperture_scatterguard: ApertureScatterguard, config_client: ConfigClient
+) -> Scintillator:
     return Scintillator(
         f"{PREFIX.beamline_prefix}-MO-SCIN-01:",
         Reference(aperture_scatterguard),
-        get_beamline_parameters(BL),
+        config_client.get_file_contents(BEAMLINE_PARAMETERS_PATH, dict),
     )
 
 

src/dodal/beamlines/i19_1.py

@@ -1,3 +1,7 @@
+from functools import cache
+
+from daq_config_server import ConfigClient
+
 from dodal.common.beamlines.beamline_utils import (
     set_beamline as set_utils_beamline,
 )
@@ -48,6 +52,12 @@
 devices = DeviceManager()
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    return ConfigClient()
+
+
 @devices.factory()
 def attenuator_motor_squad() -> AttenuatorMotorSquad:
     return AttenuatorMotorSquad(
@@ -62,7 +72,7 @@ def beamstop() -> BeamStop:
 
 @devices.fixture
 def oav_config() -> OAVConfigBeamCentre:
-    return OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG)
+    return OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG, config_client())
 
 
 @devices.factory()

src/dodal/beamlines/i24.py

@@ -68,6 +68,12 @@ def path_provider() -> PathProvider:
     )
 
 
+@devices.fixture
+@cache
+def config_client() -> ConfigClient:
+    return ConfigClient()
+
+
 @devices.factory()
 def attenuator() -> EnumFilterAttenuator:
     return EnumFilterAttenuator(
@@ -110,10 +116,10 @@ def pmac() -> PMAC:
 
 
 @devices.factory()
-def oav() -> OAVBeamCentreFile:
+def oav(config_client) -> OAVBeamCentreFile:
     return OAVBeamCentreFile(
         prefix=f"{PREFIX.beamline_prefix}-DI-OAV-01:",
-        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG),
+        config=OAVConfigBeamCentre(ZOOM_PARAMS_FILE, DISPLAY_CONFIG, config_client),
     )
 
 

src/dodal/devices/oav/oav_parameters.py

@@ -1,11 +1,12 @@
-import json
 from abc import abstractmethod
 from collections import ChainMap
 from dataclasses import dataclass
 from typing import Any, Generic, TypeVar
-from xml.etree import ElementTree
 from xml.etree.ElementTree import Element
 
+from daq_config_server import ConfigClient
+from daq_config_server.models import DisplayConfig
+
 # GDA currently assumes this aspect ratio for the OAV window size.
 # For some beamline this doesn't affect anything as the actual OAV aspect ratio
 # matches. Others need to take it into account to rescale the values stored in
@@ -34,20 +35,24 @@ def __init__(
     ):
         self.oav_config_json: str = oav_config_json
         self.context = context
+        config_server = ConfigClient(url="https://daq-config.diamond.ac.uk")
 
-        self.global_params, self.context_dicts = self.load_json(self.oav_config_json)
+        self.global_params, self.context_dicts = self.load_json(
+            config_server, self.oav_config_json
+        )
         self.active_params: ChainMap = ChainMap(
             self.context_dicts[self.context], self.global_params
         )
         self.update_self_from_current_context()
 
     @staticmethod
-    def load_json(filename: str) -> tuple[dict[str, Any], dict[str, dict]]:
-        """Loads the json from the specified file, and returns a dict with all the
+    def load_json(
+        config_server: ConfigClient, filename: str
+    ) -> tuple[dict[str, Any], dict[str, dict]]:
+        """Loads the specified file from the config server, and returns a dict with all the
         individual top-level k-v pairs, and one with all the subdicts.
         """
-        with open(filename) as f:
-            raw_params: dict[str, Any] = json.load(f)
+        raw_params: dict[str, Any] = config_server.get_file_contents(filename, dict)
         global_params = {
             k: raw_params.pop(k)
             for k, v in list(raw_params.items())
@@ -116,21 +121,20 @@ class ZoomParamsCrosshair(ZoomParams):
 
 
 class OAVConfigBase(Generic[ParamType]):
-    def __init__(self, zoom_params_file: str):
-        self.zoom_params = self._get_zoom_params(zoom_params_file)
-
-    def _get_zoom_params(self, zoom_params_file: str):
-        tree = ElementTree.parse(zoom_params_file)
-        root = tree.getroot()
-        return root.findall(".//zoomLevel")
+    def __init__(self, zoom_params_file: str, config_client: ConfigClient):
+        self.zoom_params = config_client.get_file_contents(zoom_params_file, dict)[
+            "JCameraManSettings"
+        ]
 
     def _read_zoom_params(self) -> dict:
         um_per_pix = {}
-        for node in self.zoom_params:
-            zoom = str(_get_element_as_float(node, "level"))
-            um_pix_x = _get_element_as_float(node, "micronsPerXPixel")
-            um_pix_y = _get_element_as_float(node, "micronsPerYPixel")
-            um_per_pix[zoom] = (um_pix_x, um_pix_y)
+        zoom_levels: list[dict] = self.zoom_params["levels"]["zoomLevel"]
+        for level in zoom_levels:
+            zoom = level["level"]
+            um_per_pix[zoom] = (
+                float(level["micronsPerXPixel"]),
+                float(level["micronsPerYPixel"]),
+            )
         return um_per_pix
 
     @abstractmethod
@@ -157,23 +161,17 @@ def __init__(
         self,
         zoom_params_file: str,
         display_config_file: str,
+        config_client: ConfigClient,
     ):
-        self.display_config = self._get_display_config(display_config_file)
-        super().__init__(zoom_params_file)
-
-    def _get_display_config(self, display_config_file: str):
-        with open(display_config_file) as f:
-            file_lines = f.readlines()
-        return file_lines
+        self.display_config = config_client.get_file_contents(
+            display_config_file, DisplayConfig
+        )
+        super().__init__(zoom_params_file, config_client)
 
     def _read_display_config(self) -> dict:
         crosshairs = {}
-        for i in range(len(self.display_config)):
-            if self.display_config[i].startswith("zoomLevel"):
-                zoom = self.display_config[i].split(" = ")[1].strip()
-                x = int(self.display_config[i + 1].split(" = ")[1])
-                y = int(self.display_config[i + 2].split(" = ")[1])
-                crosshairs[zoom] = (x, y)
+        for zoom, values in self.display_config.zoom_levels.items():
+            crosshairs[str(zoom)] = (values.crosshair_x, values.crosshair_y)
         return crosshairs
 
     def get_parameters(self) -> dict[str, ZoomParamsCrosshair]:

system_tests/conftest.py

@@ -1,2 +1,5 @@
 # Add run_engine to be used in tests
-pytest_plugins = ["dodal.testing.fixtures.run_engine"]
+pytest_plugins = [
+    "dodal.testing.fixtures.run_engine",
+    "dodal.testing.fixtures.config_server",
+]