add: chaser filter

Project-Editor.spec

@@ -6,6 +6,7 @@ added_files = [
          ( 'src/resources/data', 'resources/data' ),
          ( 'src/resources/fonts', 'resources/fonts' ),
          ( 'src/resources/icons', 'resources/icons' ),
+         ( 'src/resources/chaser_layer_help', 'resources/chaser_layer_help' ),
          ( 'src/configs','configs')
          ]
 

src/controller/cli/cli_context.py

@@ -12,6 +12,7 @@
 from controller.cli.bankset_command import BankSetCommand
 from controller.cli.connect_command import ConnectCommand
 from controller.cli.event_command import EventCommand
+from controller.cli.extract_command import ExtractCommand
 from controller.cli.fish_con_command import FishConnCommand
 from controller.cli.help_command import HelpCommand
 from controller.cli.list_command import ListCommand
@@ -106,6 +107,7 @@ def __init__(self, show: BoardConfiguration, network_manager: NetworkManager, ex
             ConnectCommand(self),
             FishConnCommand(self),
             UIPageCommand(self),
+            ExtractCommand(self),
         ]
         self._selected_bank: BankSet | None = None
         self._selected_scene: Scene | None = None

src/controller/cli/extract_command.py

@@ -0,0 +1,67 @@
+"""Contains extract command."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, override
+
+from controller.cli.command import Command
+
+if TYPE_CHECKING:
+    from argparse import ArgumentParser, Namespace
+
+    from controller.cli.cli_context import CLIContext
+
+
+class ExtractCommand(Command):
+    """Command to extract element from list."""
+
+    def __init__(self, context: CLIContext) -> None:
+        """Initialize the command."""
+        super().__init__(context, "extract")
+        self._help_text = "Extract element from list"
+
+    @override
+    def configure_parser(self, parser: ArgumentParser) -> None:
+        parser.add_argument("destination", type=str, help="Destination variable.")
+        parser.add_argument("element", type=int, help="Index of element to extract.")
+        subparsers = parser.add_subparsers(dest="target", help="Extraction target.")
+        for target in ["filter-param", "filter-config"]:
+            filter_param_parser = subparsers.add_parser(
+                target,
+                help=f"Extract {target} from filter.",
+                exit_on_error=False
+            )
+            filter_param_parser.add_argument("--scene", type=int, default=-1,
+                                             help="Scene of the filter. Default: Current selected scene.")
+            filter_param_parser.add_argument("fid", type=str, help="Filter ID.")
+            filter_param_parser.add_argument("parameter", type=str, help="The parameter to extract.")
+            filter_param_parser.add_argument("delimiter", type=str, help="The delimiter to use.")
+
+    @override
+    def execute(self, args: Namespace) -> bool:
+        match args.target:
+            case "filter-param" | "filter-config":
+                scene = args.scene
+                if scene == -1:
+                    scene = self.context.selected_scene
+                if scene is None:
+                    self.context.print("Error: No scene specified.")
+                    return False
+                if isinstance(scene, int):
+                    scene = self.context.show.get_scene_by_id(scene)
+                if scene is None:
+                    self.context.print("Error: No scene with specified ID exists.")
+                    return False
+                filter_inst = scene.get_filter_by_id(args.fid)
+                if filter_inst is None:
+                    self.context.print(f"Error: No filter with ID '{args.fid}' not found.")
+                    return False
+                selected_dict = filter_inst.initial_parameters if args.target == "filter-param"\
+                    else filter_inst.filter_configurations
+                splitted_param = selected_dict.get(args.parameter, "").split(args.delimiter)
+                element = splitted_param[args.element] if abs(args.element) < len(splitted_param) else ""
+                if len(args.destination) < 0:
+                    self.context.print("Error: Invalid destination variable.")
+                    return False
+                self.context.update_variables({args.destination: element})
+                return True

src/controller/cli/help_command.py

@@ -32,6 +32,13 @@ def execute(self, args: Namespace) -> bool:
                 self.context.print("\tscene -- Select the scene to perform actions on")
                 self.context.print("\tcolumn -- Select the control desk column to perform actions on")
                 self.context.print("\tbank_set -- Select the control desk bank set to perform actions on")
+            case "extract":
+                self.context.print("Use this command to extract data from concatenated lists and store it in the "
+                                   "specified destination variable.")
+                self.context.print("Usage: extract <destination> <element> <target> <...>")
+                self.context.print("The following targets exist:")
+                self.context.print("\tfilter-param [--scene <scene>] <filter-id> <parameter> <delimiter>")
+                self.context.print("\tfilter-config [--scene <scene>] <filter-id> <parameter> <delimiter>")
             case "list":
                 self.context.print("This command displays the content of system collections.")
                 self.context.print("The following containers can be queried:")
@@ -99,6 +106,6 @@ def execute(self, args: Namespace) -> bool:
                 self.context.print(f"ERROR: The requested help topic '{args.topic}' is unknown.")
                 self.context.print("The following topics are known:")
                 self.context.print("\tevent\tselect\tlist\tpatch\tbank_set\tshowctl\tdelay\tmacro")
-                self.context.print("\tprint\tasset\tset\tif\tconnect\tfish\tuipage")
+                self.context.print("\tprint\tasset\tset\tif\tconnect\tfish\tuipage\textract")
                 return False
         return True

src/model/events.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from logging import getLogger
+from typing import NamedTuple
 
 import proto.Events_pb2
 from controller.network import NetworkManager
@@ -63,6 +64,34 @@ def handle_incoming_sender_update(msg: proto.Events_pb2.event_sender) -> None:
 _broadcaster_instance.event_sender_update.connect(handle_incoming_sender_update)
 
 
+class EventFilter(NamedTuple):
+    """Event Filter Description."""
+
+    event_sender: int
+    event_sender_function: int
+    args: list[int]
+
+    @staticmethod
+    def from_filter_str(filter_str: str) -> EventFilter:
+        """Create a EventFilter instance from a filter string."""
+        parts = filter_str.split(":")
+        if len(parts) < 2:
+            raise ValueError(f"Invalid filter string: '{filter_str}'")
+        ef = EventFilter()
+        ef.event_sender = int(parts[0])
+        ef.event_sender_function = int(parts[1])
+        parts.pop(0)
+        parts.pop(0)
+        for arg in parts:
+            ef.args.append(int(arg))
+
+    def format_for_filters(self) -> str:
+        """Serialize the event filter into a string representation."""
+        mlist = [str(self.event_sender), str(self.event_sender_function)]
+        mlist.extend(str(i) for i in self.args)
+        return ":".join(mlist)
+
+
 class EventSender:
     """Base class for fish event sender representations.
 

src/model/filter.py

@@ -171,6 +171,7 @@ class FilterTypeEnumeration(IntFlag):
     FILTER_RESPONDING_CONSTANT_16BIT = 72
     FILTER_RESPONDING_CONSTANT_FLOAT = 73
     FILTER_RESPONDING_CONSTANT_COLOR = 74
+    FILTER_COLOR_CHASER = 75
 
 
 class Filter: