Merge pull request #52 from DiamondLightSource/fr-unique-config

Define FrameReceiver unique config

src/fastcs_odin/frame_processor.py

@@ -0,0 +1,107 @@
+import re
+from collections.abc import Sequence
+
+from fastcs.attributes import AttrR
+from fastcs.datatypes import Bool, Int
+
+from fastcs_odin.odin_adapter_controller import (
+    OdinAdapterController,
+    StatusSummaryUpdater,
+)
+from fastcs_odin.odin_data import OdinDataAdapterController, OdinDataController
+from fastcs_odin.util import OdinParameter, partition
+
+
+class FrameProcessorController(OdinDataController):
+    """Sub controller for a frame processor application."""
+
+    async def initialise(self):
+        plugins_response = await self.connection.get(
+            f"{self._api_prefix}/status/plugins/names"
+        )
+        match plugins_response:
+            case {"names": [*plugin_list]}:
+                plugins = tuple(a for a in plugin_list if isinstance(a, str))
+                if len(plugins) != len(plugin_list):
+                    raise ValueError(f"Received invalid plugins list:\n{plugin_list}")
+            case _:
+                raise ValueError(
+                    f"Did not find valid plugins in response:\n{plugins_response}"
+                )
+
+        self._process_parameters()
+        await self._create_plugin_sub_controllers(plugins)
+        self._create_attributes()
+
+    async def _create_plugin_sub_controllers(self, plugins: Sequence[str]):
+        for plugin in plugins:
+
+            def __parameter_in_plugin(
+                parameter: OdinParameter, plugin: str = plugin
+            ) -> bool:
+                return parameter.path[0] == plugin
+
+            plugin_parameters, self.parameters = partition(
+                self.parameters, __parameter_in_plugin
+            )
+            plugin_controller = FrameProcessorPluginController(
+                self.connection,
+                plugin_parameters,
+                f"{self._api_prefix}",
+            )
+            self.register_sub_controller(plugin.upper(), plugin_controller)
+            await plugin_controller.initialise()
+
+
+class FrameProcessorAdapterController(OdinDataAdapterController):
+    frames_written: AttrR = AttrR(
+        Int(),
+        handler=StatusSummaryUpdater([re.compile("FP*"), "HDF"], "frames_written", sum),
+    )
+    writing: AttrR = AttrR(
+        Bool(),
+        handler=StatusSummaryUpdater([re.compile("FP*"), "HDF"], "writing", any),
+    )
+    _unique_config = [
+        "rank",
+        "number",
+        "ctrl_endpoint",
+        "meta_endpoint",
+        "fr_ready_cnxn",
+        "fr_release_cnxn",
+    ]
+    _subcontroller_label = "FP"
+    _subcontroller_cls = FrameProcessorController
+
+
+class FrameProcessorPluginController(OdinAdapterController):
+    """SubController for a plugin in a frameProcessor application."""
+
+    async def initialise(self):
+        if any("dataset" in p.path for p in self.parameters):
+
+            def __dataset_parameter(param: OdinParameter):
+                return "dataset" in param.path
+
+            dataset_parameters, self.parameters = partition(
+                self.parameters, __dataset_parameter
+            )
+            if dataset_parameters:
+                dataset_controller = FrameProcessorDatasetController(
+                    self.connection, dataset_parameters, f"{self._api_prefix}"
+                )
+                self.register_sub_controller("DS", dataset_controller)
+                await dataset_controller.initialise()
+
+        return await super().initialise()
+
+    def _process_parameters(self):
+        for parameter in self.parameters:
+            # Remove plugin name included in controller base path
+            parameter.set_path(parameter.path[1:])
+
+
+class FrameProcessorDatasetController(OdinAdapterController):
+    def _process_parameters(self):
+        for parameter in self.parameters:
+            parameter.set_path(parameter.uri[3:])

src/fastcs_odin/frame_receiver.py

@@ -0,0 +1,47 @@
+from fastcs_odin.odin_adapter_controller import (
+    OdinAdapterController,
+)
+from fastcs_odin.odin_data import OdinDataAdapterController, OdinDataController
+from fastcs_odin.util import OdinParameter, partition
+
+
+class FrameReceiverController(OdinDataController):
+    async def initialise(self):
+        self._process_parameters()
+
+        def __decoder_parameter(parameter: OdinParameter):
+            return "decoder" in parameter.path[:-1]
+
+        decoder_parameters, self.parameters = partition(
+            self.parameters, __decoder_parameter
+        )
+        decoder_controller = FrameReceiverDecoderController(
+            self.connection, decoder_parameters, f"{self._api_prefix}"
+        )
+        self.register_sub_controller("DECODER", decoder_controller)
+        await decoder_controller.initialise()
+        self._create_attributes()
+
+
+class FrameReceiverAdapterController(OdinDataAdapterController):
+    _subcontroller_label = "FR"
+    _subcontroller_cls = FrameReceiverController
+    _unique_config = [
+        "rank",
+        "number",
+        "ctrl_endpoint",
+        "fr_ready_cnxn",
+        "fr_release_cnxn",
+        "frame_ready_endpoint",
+        "frame_release_endpoint",
+        "shared_buffer_name",
+        "rx_address",
+        "rx_ports",
+    ]
+
+
+class FrameReceiverDecoderController(OdinAdapterController):
+    def _process_parameters(self):
+        for parameter in self.parameters:
+            # remove redundant status/decoder part from path
+            parameter.set_path(parameter.uri[2:])

src/fastcs_odin/odin_controller.py

@@ -3,13 +3,11 @@
 from fastcs.datatypes import Bool, Float, Int, String
 
 from fastcs_odin.eiger_fan import EigerFanAdapterController
+from fastcs_odin.frame_processor import FrameProcessorAdapterController
+from fastcs_odin.frame_receiver import FrameReceiverAdapterController
 from fastcs_odin.http_connection import HTTPConnection
 from fastcs_odin.meta_writer import MetaWriterAdapterController
 from fastcs_odin.odin_adapter_controller import OdinAdapterController
-from fastcs_odin.odin_data import (
-    FrameProcessorAdapterController,
-    FrameReceiverAdapterController,
-)
 from fastcs_odin.util import AdapterType, OdinParameter, create_odin_parameters
 
 types = {"float": Float(), "int": Int(), "bool": Bool(), "str": String()}

src/fastcs_odin/odin_data.py

@@ -1,15 +1,12 @@
 import logging
-import re
-from collections.abc import Iterable, Sequence
+from collections.abc import Iterable
 
-from fastcs.attributes import AttrR, AttrW
+from fastcs.attributes import AttrW
 from fastcs.controller import BaseController, SubController
-from fastcs.datatypes import Bool, Int
 
 from fastcs_odin.odin_adapter_controller import (
     ConfigFanSender,
     OdinAdapterController,
-    StatusSummaryUpdater,
 )
 from fastcs_odin.util import OdinParameter, partition
 
@@ -96,131 +93,6 @@ def _create_config_fan_attributes(self):
             )
 
 
-class FrameReceiverController(OdinDataController):
-    async def initialise(self):
-        self._process_parameters()
-
-        def __decoder_parameter(parameter: OdinParameter):
-            return "decoder" in parameter.path[:-1]
-
-        decoder_parameters, self.parameters = partition(
-            self.parameters, __decoder_parameter
-        )
-        decoder_controller = FrameReceiverDecoderController(
-            self.connection, decoder_parameters, f"{self._api_prefix}"
-        )
-        self.register_sub_controller("DECODER", decoder_controller)
-        await decoder_controller.initialise()
-        self._create_attributes()
-
-
-class FrameReceiverAdapterController(OdinDataAdapterController):
-    _subcontroller_label = "FR"
-    _subcontroller_cls = FrameReceiverController
-
-
-class FrameReceiverDecoderController(OdinAdapterController):
-    def _process_parameters(self):
-        for parameter in self.parameters:
-            # remove redundant status/decoder part from path
-            parameter.set_path(parameter.uri[2:])
-
-
-class FrameProcessorController(OdinDataController):
-    """Sub controller for a frame processor application."""
-
-    async def initialise(self):
-        plugins_response = await self.connection.get(
-            f"{self._api_prefix}/status/plugins/names"
-        )
-        match plugins_response:
-            case {"names": [*plugin_list]}:
-                plugins = tuple(a for a in plugin_list if isinstance(a, str))
-                if len(plugins) != len(plugin_list):
-                    raise ValueError(f"Received invalid plugins list:\n{plugin_list}")
-            case _:
-                raise ValueError(
-                    f"Did not find valid plugins in response:\n{plugins_response}"
-                )
-
-        self._process_parameters()
-        await self._create_plugin_sub_controllers(plugins)
-        self._create_attributes()
-
-    async def _create_plugin_sub_controllers(self, plugins: Sequence[str]):
-        for plugin in plugins:
-
-            def __parameter_in_plugin(
-                parameter: OdinParameter, plugin: str = plugin
-            ) -> bool:
-                return parameter.path[0] == plugin
-
-            plugin_parameters, self.parameters = partition(
-                self.parameters, __parameter_in_plugin
-            )
-            plugin_controller = FrameProcessorPluginController(
-                self.connection,
-                plugin_parameters,
-                f"{self._api_prefix}",
-            )
-            self.register_sub_controller(plugin.upper(), plugin_controller)
-            await plugin_controller.initialise()
-
-
-class FrameProcessorAdapterController(OdinDataAdapterController):
-    frames_written: AttrR = AttrR(
-        Int(),
-        handler=StatusSummaryUpdater([re.compile("FP*"), "HDF"], "frames_written", sum),
-    )
-    writing: AttrR = AttrR(
-        Bool(),
-        handler=StatusSummaryUpdater([re.compile("FP*"), "HDF"], "writing", any),
-    )
-    _unique_config = [
-        "rank",
-        "number",
-        "ctrl_endpoint",
-        "meta_endpoint",
-        "fr_ready_cnxn",
-        "fr_release_cnxn",
-    ]
-    _subcontroller_label = "FP"
-    _subcontroller_cls = FrameProcessorController
-
-
-class FrameProcessorPluginController(OdinAdapterController):
-    """SubController for a plugin in a frameProcessor application."""
-
-    async def initialise(self):
-        if any("dataset" in p.path for p in self.parameters):
-
-            def __dataset_parameter(param: OdinParameter):
-                return "dataset" in param.path
-
-            dataset_parameters, self.parameters = partition(
-                self.parameters, __dataset_parameter
-            )
-            if dataset_parameters:
-                dataset_controller = FrameProcessorDatasetController(
-                    self.connection, dataset_parameters, f"{self._api_prefix}"
-                )
-                self.register_sub_controller("DS", dataset_controller)
-                await dataset_controller.initialise()
-
-        return await super().initialise()
-
-    def _process_parameters(self):
-        for parameter in self.parameters:
-            # Remove plugin name included in controller base path
-            parameter.set_path(parameter.path[1:])
-
-
-class FrameProcessorDatasetController(OdinAdapterController):
-    def _process_parameters(self):
-        for parameter in self.parameters:
-            parameter.set_path(parameter.uri[3:])
-
-
 def get_all_sub_controllers(
     controller: "OdinAdapterController",
 ) -> list["OdinAdapterController"]:

tests/test_controllers.py

@@ -8,25 +8,24 @@
 from pytest_mock import MockerFixture
 
 from fastcs_odin.eiger_fan import EigerFanAdapterController
-from fastcs_odin.http_connection import HTTPConnection
-from fastcs_odin.meta_writer import MetaWriterAdapterController
-from fastcs_odin.odin_adapter_controller import (
-    ConfigFanSender,
-    ParamTreeHandler,
-    StatusSummaryUpdater,
-)
-from fastcs_odin.odin_controller import (
-    OdinAdapterController,
-    OdinController,
-)
-from fastcs_odin.odin_data import (
+from fastcs_odin.frame_processor import (
     FrameProcessorAdapterController,
     FrameProcessorController,
     FrameProcessorPluginController,
+)
+from fastcs_odin.frame_receiver import (
     FrameReceiverAdapterController,
     FrameReceiverController,
     FrameReceiverDecoderController,
 )
+from fastcs_odin.http_connection import HTTPConnection
+from fastcs_odin.meta_writer import MetaWriterAdapterController
+from fastcs_odin.odin_adapter_controller import (
+    ConfigFanSender,
+    ParamTreeHandler,
+    StatusSummaryUpdater,
+)
+from fastcs_odin.odin_controller import OdinAdapterController, OdinController
 from fastcs_odin.util import AdapterType, OdinParameter
 
 HERE = Path(__file__).parent

tests/test_introspection.py

@@ -4,9 +4,11 @@
 import pytest
 from pytest_mock import MockerFixture
 
-from fastcs_odin.odin_data import (
+from fastcs_odin.frame_processor import (
     FrameProcessorAdapterController,
     FrameProcessorController,
+)
+from fastcs_odin.frame_receiver import (
     FrameReceiverAdapterController,
     FrameReceiverController,
 )