Add OdinAdapterController to parse commands at root of attribute

Author: GDYendell

src/fastcs_odin/controllers/odin_adapter_controller.py

@@ -0,0 +1,13 @@
+from fastcs.logging import bind_logger
+
+from fastcs_odin.controllers.odin_subcontroller import OdinSubController
+
+logger = bind_logger(logger_name=__name__)
+
+
+class OdinAdapterController(OdinSubController):
+    """Sub controller for an adapter in an odin control server"""
+
+    async def initialise(self):
+        await self._create_attributes()
+        await self._create_commands()

src/fastcs_odin/controllers/odin_controller.py

@@ -2,6 +2,7 @@
 from fastcs.connections.ip_connection import IPConnectionSettings
 from fastcs.controllers import BaseController, Controller
 
+from fastcs_odin.controllers.odin_adapter_controller import OdinAdapterController
 from fastcs_odin.controllers.odin_data.frame_processor import (
     FrameProcessorAdapterController,
 )
@@ -98,6 +99,6 @@ def _create_adapter_controller(
                     connection, parameters, f"{self.API_PREFIX}/{adapter}", self._ios
                 )
             case _:
-                return OdinSubController(
+                return OdinAdapterController(
                     connection, parameters, f"{self.API_PREFIX}/{adapter}", self._ios
                 )

src/fastcs_odin/controllers/odin_data/frame_processor.py

@@ -6,8 +6,7 @@
 from fastcs.attributes import AttrR, AttrRW
 from fastcs.datatypes import Bool, Int
 from fastcs.logging import bind_logger
-from fastcs.methods import Command, command
-from pydantic import ValidationError
+from fastcs.methods import command
 
 from fastcs_odin.controllers.odin_data.odin_data_adapter import (
     OdinDataAdapterController,
@@ -17,12 +16,7 @@
     StatusSummaryAttributeIORef,
     _filter_sub_controllers,
 )
-from fastcs_odin.util import (
-    AllowedCommandsResponse,
-    OdinParameter,
-    create_attribute,
-    partition,
-)
+from fastcs_odin.util import OdinParameter, create_attribute, partition
 
 logger = bind_logger(logger_name=__name__)
 
@@ -155,8 +149,6 @@ class FrameProcessorPluginController(OdinSubController):
     """Controller for a plugin in a frameProcessor application."""
 
     async def initialise(self):
-        await self._create_commands()
-        await self._create_dataset_controllers()
         for parameter in self.parameters:
             # Remove plugin name included in controller base path
             parameter.set_path(parameter.path[1:])
@@ -172,18 +164,10 @@ async def initialise(self):
                 create_attribute(parameter=parameter, api_prefix=self._api_prefix),
             )
 
-    async def _create_commands(self):
         plugin_name = self.path[-1].lower()
-        command_response = await self.connection.get(
-            f"{self._api_prefix}/command/{plugin_name}/allowed"
-        )
+        await self._create_commands([plugin_name])
 
-        try:
-            commands = AllowedCommandsResponse.model_validate(command_response)
-            for command in commands.allowed:
-                self._construct_command(command, plugin_name)
-        except ValidationError:
-            pass
+        await self._create_dataset_controllers()
 
     async def _create_dataset_controllers(self):
         if any("dataset" in p.path for p in self.parameters):
@@ -204,15 +188,6 @@ def __dataset_parameter(param: OdinParameter):
                 self.add_sub_controller("DS", dataset_controller)
                 await dataset_controller.initialise()
 
-    def _construct_command(self, command_name, plugin_name):
-        async def submit_command() -> None:
-            logger.info("Executing command", plugin=plugin_name, command=command_name)
-            await self.connection.put(
-                f"{self._api_prefix}/command/{plugin_name}/execute", command_name
-            )
-
-        setattr(self, command_name, Command(submit_command))
-
 
 class FrameProcessorDatasetController(OdinSubController):
     """Controller for datasets in the HDF plugin of a frameProcessor application"""

src/fastcs_odin/controllers/odin_subcontroller.py

@@ -3,9 +3,14 @@
 from fastcs.attributes import AttributeIO, AttributeIORefT
 from fastcs.controllers import Controller
 from fastcs.datatypes import DType_T
+from fastcs.logging import bind_logger
+from fastcs.methods import Command
+from pydantic import ValidationError
 
 from fastcs_odin.http_connection import HTTPConnection
-from fastcs_odin.util import OdinParameter, create_attribute
+from fastcs_odin.util import AllowedCommandsResponse, OdinParameter, create_attribute
+
+logger = bind_logger(logger_name=__name__)
 
 
 class OdinSubController(Controller):
@@ -33,8 +38,58 @@ def __init__(
         self._ios = ios
 
     async def initialise(self):
+        await self._create_attributes()
+
+    async def _create_attributes(self):
+        """Create an `Attribute` for each parameter"""
+
         for parameter in self.parameters:
             self.add_attribute(
                 parameter.name,
                 create_attribute(parameter=parameter, api_prefix=self._api_prefix),
             )
+
+    async def _create_commands(self, path: Sequence[str] = ()):
+        """Create a `Command` for each allowed command in the odin server
+
+        Args:
+            path: The sub path to the command under ``self._api_prefix``
+
+        """
+        response = await self.connection.get(
+            f"{self._api_prefix}/command{'/' + '/'.join(path) if path else ''}/allowed"
+        )
+
+        try:
+            commands = AllowedCommandsResponse.model_validate(response)
+        except ValidationError:
+            logger.warning(
+                "Failed to parse command response",
+                path=self.path,
+                response=response,
+            )
+            return
+
+        for command in commands.allowed:
+            self._create_command(command, path)
+
+    def _create_command(self, name: str, path: Sequence[str] = ()):
+        """Create a `Command` that sends a command to the odin server
+
+        Args:
+            name: The name of the command
+            path: The sub path to the command under ``self._api_prefix``
+
+        """
+        uri = (
+            f"{self._api_prefix}/command{'/' + '/'.join(path) if path else ''}/execute"
+        )
+
+        async def submit_command() -> None:
+            logger.info(
+                "Executing command", controller=self.path, command=name, path=path
+            )
+
+            await self.connection.put(uri, name)
+
+        setattr(self, name, Command(submit_command))