feat(template overview): If an FC is connected only present templates for that vehicle type

Author: amilcarlucas

ardupilot_methodic_configurator/__main__.py

@@ -164,7 +164,7 @@ def component_editor(
         sys_exit(1)
 
 
-def main() -> None:
+def main() -> None:  # pylint: disable=too-many-locals
     args = create_argument_parser().parse_args()
 
     logging_basicConfig(level=logging_getLevelName(args.loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
@@ -209,7 +209,9 @@ def main() -> None:
 
     vehicle_dir_window = None
     if not files:
-        vehicle_dir_window = VehicleDirectorySelectionWindow(local_filesystem, len(flight_controller.fc_parameters) > 0)
+        fc_connected = len(flight_controller.fc_parameters) > 0
+        connected_fc_vehicle_type = flight_controller.info.vehicle_type if fc_connected else ""
+        vehicle_dir_window = VehicleDirectorySelectionWindow(local_filesystem, fc_connected, connected_fc_vehicle_type)
         vehicle_dir_window.root.mainloop()
 
     component_editor(args, flight_controller, local_filesystem.vehicle_type, local_filesystem, vehicle_dir_window)

ardupilot_methodic_configurator/frontend_tkinter_directory_selection.py

@@ -30,7 +30,7 @@
 from ardupilot_methodic_configurator.frontend_tkinter_template_overview import TemplateOverviewWindow
 
 
-class DirectorySelectionWidgets:
+class DirectorySelectionWidgets:  # pylint: disable=too-many-instance-attributes
     """
     A class to manage directory selection widgets in the GUI.
 
@@ -49,12 +49,14 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
         dir_tooltip: str,
         button_tooltip: str,
         is_template_selection: bool,
+        connected_fc_vehicle_type: str,
     ) -> None:
         self.parent = parent
         self.directory: str = deepcopy(initialdir)
         self.label_text = label_text
         self.autoresize_width = autoresize_width
         self.is_template_selection = is_template_selection
+        self.connected_fc_vehicle_type = connected_fc_vehicle_type
 
         # Create a new frame for the directory selection label and button
         self.container_frame = ttk.Frame(parent_frame)
@@ -89,7 +91,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
     def on_select_directory(self) -> bool:
         if self.is_template_selection:
             if isinstance(self.parent.root, tk.Tk):  # this keeps mypy and pyright happy
-                to = TemplateOverviewWindow(self.parent.root)
+                to = TemplateOverviewWindow(self.parent.root, connected_fc_vehicle_type=self.connected_fc_vehicle_type)
                 to.run_app()
             selected_directory = ProgramSettings.get_recently_used_dirs()[0]
             logging_info(_("Selected template directory: %s"), selected_directory)
@@ -158,6 +160,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
         local_filesystem: LocalFilesystem,
         initial_dir: str,
         destroy_parent_on_open: bool,
+        connected_fc_vehicle_type: str = "",
     ) -> None:
         # Call the parent constructor with the necessary arguments
         super().__init__(
@@ -177,6 +180,7 @@ def __init__(  # pylint: disable=too-many-arguments, too-many-positional-argumen
             if destroy_parent_on_open
             else "",
             is_template_selection=False,
+            connected_fc_vehicle_type=connected_fc_vehicle_type,
         )
         self.local_filesystem = local_filesystem
         self.destroy_parent_on_open = destroy_parent_on_open
@@ -231,9 +235,12 @@ class VehicleDirectorySelectionWindow(BaseWindow):  # pylint: disable=too-many-i
     vehicle configuration directory.
     """
 
-    def __init__(self, local_filesystem: LocalFilesystem, fc_connected: bool = False) -> None:
+    def __init__(
+        self, local_filesystem: LocalFilesystem, fc_connected: bool = False, connected_fc_vehicle_type: str = ""
+    ) -> None:
         super().__init__()
         self.local_filesystem = local_filesystem
+        self.connected_fc_vehicle_type = connected_fc_vehicle_type
         self.root.title(
             _("Amilcar Lucas's - ArduPilot methodic configurator ")
             + __version__
@@ -259,7 +266,7 @@ def __init__(self, local_filesystem: LocalFilesystem, fc_connected: bool = False
         )
         introduction_label.pack(expand=False, fill=tk.X, padx=6, pady=6)
         template_dir, new_base_dir, vehicle_dir = LocalFilesystem.get_recently_used_dirs()
-        self.create_option1_widgets(template_dir, new_base_dir, _("MyVehicleName"), fc_connected)
+        self.create_option1_widgets(template_dir, new_base_dir, _("MyVehicleName"), fc_connected, connected_fc_vehicle_type)
         self.create_option2_widgets(vehicle_dir)
         self.create_option3_widgets(vehicle_dir)
 
@@ -269,8 +276,13 @@ def __init__(self, local_filesystem: LocalFilesystem, fc_connected: bool = False
     def close_and_quit(self) -> None:
         sys_exit(0)
 
-    def create_option1_widgets(  # pylint: disable=too-many-locals
-        self, initial_template_dir: str, initial_base_dir: str, initial_new_dir: str, fc_connected: bool
+    def create_option1_widgets(  # pylint: disable=too-many-locals,too-many-arguments,too-many-positional-arguments
+        self,
+        initial_template_dir: str,
+        initial_base_dir: str,
+        initial_new_dir: str,
+        fc_connected: bool,
+        connected_fc_vehicle_type: str,
     ) -> None:
         # Option 1 - Create a new vehicle configuration directory based on an existing template
         option1_label = ttk.Label(text=_("New vehicle"), style="Bold.TLabel")
@@ -293,6 +305,7 @@ def create_option1_widgets(  # pylint: disable=too-many-locals
             dir_tooltip=template_dir_edit_tooltip,
             button_tooltip=template_dir_btn_tooltip,
             is_template_selection=True,
+            connected_fc_vehicle_type=connected_fc_vehicle_type,
         )
         self.template_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
         blank_component_data_checkbox = ttk.Checkbutton(
@@ -364,6 +377,7 @@ def create_option1_widgets(  # pylint: disable=too-many-locals
             dir_tooltip=new_base_dir_edit_tooltip,
             button_tooltip=new_base_dir_btn_tooltip,
             is_template_selection=False,
+            connected_fc_vehicle_type="",
         )
         self.new_base_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
         new_dir_edit_tooltip = _(
@@ -404,7 +418,12 @@ def create_option2_widgets(self, initial_dir: str) -> None:
         )
         option2_label.pack(expand=False, fill=tk.X, padx=6)
         self.connection_selection_widgets = VehicleDirectorySelectionWidgets(
-            self, option2_label_frame, self.local_filesystem, initial_dir, destroy_parent_on_open=True
+            self,
+            option2_label_frame,
+            self.local_filesystem,
+            initial_dir,
+            destroy_parent_on_open=True,
+            connected_fc_vehicle_type=self.connected_fc_vehicle_type,
         )
         self.connection_selection_widgets.container_frame.pack(expand=True, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
 
@@ -423,6 +442,7 @@ def create_option3_widgets(self, last_vehicle_dir: str) -> None:
             dir_tooltip=_("Last used vehicle configuration directory"),
             button_tooltip="",
             is_template_selection=False,
+            connected_fc_vehicle_type="",
         )
         last_dir.container_frame.pack(expand=False, fill=tk.X, padx=3, pady=5, anchor=tk.NW)
 

ardupilot_methodic_configurator/frontend_tkinter_parameter_editor.py

@@ -205,8 +205,14 @@ def __create_conf_widgets(self, version: str) -> None:
 
         # Create a new frame inside the config_subframe for the intermediate parameter file directory selection labels
         # and directory selection button
+        connected_vehicle_type = self.flight_controller.info.vehicle_type if self.flight_controller.info.vehicle_type else ""
         directory_selection_frame = VehicleDirectorySelectionWidgets(
-            self, config_subframe, self.local_filesystem, self.local_filesystem.vehicle_dir, destroy_parent_on_open=False
+            self,
+            config_subframe,
+            self.local_filesystem,
+            self.local_filesystem.vehicle_dir,
+            destroy_parent_on_open=False,
+            connected_fc_vehicle_type=connected_vehicle_type,
         )
         if self.gui_complexity != "simple":
             directory_selection_frame.container_frame.pack(side=tk.LEFT, fill="x", expand=False, padx=(4, 6))

ardupilot_methodic_configurator/frontend_tkinter_template_overview.py

@@ -77,6 +77,7 @@ def __init__(
         parent: Optional[tk.Tk] = None,
         vehicle_components_provider: Optional[VehicleComponentsProviderProtocol] = None,
         program_settings_provider: Optional[ProgramSettingsProviderProtocol] = None,
+        connected_fc_vehicle_type: Optional[str] = None,
     ) -> None:
         """
         Initialize the TemplateOverviewWindow.
@@ -85,6 +86,7 @@ def __init__(
             parent: Optional parent Tk window
             vehicle_components_provider: Optional provider for vehicle components (for dependency injection)
             program_settings_provider: Optional provider for program settings (for dependency injection)
+            connected_fc_vehicle_type: Optional firmware type of connected flight controller for filtering templates
 
         """
         super().__init__(parent)
@@ -101,7 +103,7 @@ def __init__(
         self._configure_window()
         self._initialize_ui_components()
         self._setup_layout()
-        self._configure_treeview()
+        self._configure_treeview(connected_fc_vehicle_type or "")
         self._bind_events()
 
     def _configure_window(self) -> None:
@@ -163,11 +165,11 @@ def run_app(self) -> None:
         elif isinstance(self.root, tk.Tk):
             self.root.mainloop()
 
-    def _configure_treeview(self) -> None:
+    def _configure_treeview(self, connected_fc_vehicle_type: str) -> None:
         """Configure the treeview with styling and data."""
         self._setup_treeview_style()
         self._setup_treeview_columns()
-        self._populate_treeview()
+        self._populate_treeview(connected_fc_vehicle_type)
         self._adjust_treeview_column_widths()
         self.tree.pack(fill=tk.BOTH, expand=True)
 
@@ -213,11 +215,19 @@ def _setup_treeview_columns(self) -> None:
         for col in self.tree["columns"]:
             self.tree.heading(col, text=col)
 
-    def _populate_treeview(self) -> None:
-        """Populate the treeview with data from vehicle components."""
+    def _populate_treeview(self, connected_fc_vehicle_type: str) -> None:
+        """
+        Populate the treeview with data from vehicle components.
+
+        Args:
+            connected_fc_vehicle_type: Optional firmware type to filter templates by
+
+        """
         for key, template_overview in self.vehicle_components_provider.get_vehicle_components_overviews().items():
             attribute_names = template_overview.attributes()
             values = (key, *(getattr(template_overview, attr, "") for attr in attribute_names))
+            if connected_fc_vehicle_type and connected_fc_vehicle_type not in key:
+                continue
             self.tree.insert("", "end", text=key, values=values)
 
     def _adjust_treeview_column_widths(self) -> None:

tests/test_frontend_tkinter_component_editor_base.py

@@ -22,7 +22,7 @@
 from ardupilot_methodic_configurator.backend_filesystem_vehicle_components import VehicleComponents
 from ardupilot_methodic_configurator.data_model_vehicle_components import ComponentDataModel
 from ardupilot_methodic_configurator.frontend_tkinter_component_editor_base import (
-    VEICLE_IMAGE_WIDTH_PIX,
+    VEHICLE_IMAGE_WIDTH_PIX,
     WINDOW_WIDTH_PIX,
     ComponentEditorWindowBase,
     EntryWidget,
@@ -666,10 +666,10 @@ class TestModuleConstants:
     def test_window_dimensions_are_reasonable(self) -> None:
         """Test that window dimensions are reasonable values."""
         assert WINDOW_WIDTH_PIX == 880
-        assert VEICLE_IMAGE_WIDTH_PIX == 100
-        assert WINDOW_WIDTH_PIX > VEICLE_IMAGE_WIDTH_PIX
+        assert VEHICLE_IMAGE_WIDTH_PIX == 100
+        assert WINDOW_WIDTH_PIX > VEHICLE_IMAGE_WIDTH_PIX
         assert WINDOW_WIDTH_PIX > 500  # Minimum reasonable width
-        assert VEICLE_IMAGE_WIDTH_PIX > 50  # Minimum reasonable image width
+        assert VEHICLE_IMAGE_WIDTH_PIX > 50  # Minimum reasonable image width
 
     def test_entry_widget_type_alias_definition(self) -> None:
         """Test that EntryWidget type alias is correctly defined."""

tests/test_frontend_tkinter_directory_selection.py

@@ -151,6 +151,7 @@ def directory_selection_widgets(root: tk.Tk, base_parent: MagicMock) -> Generato
             dir_tooltip="Test directory tooltip",
             button_tooltip="Select directory button tooltip",
             is_template_selection=False,
+            connected_fc_vehicle_type="",
         )
         yield widget
 
@@ -214,6 +215,7 @@ def test_directory_selection_widgets_template_selection(base_parent, root) -> No
                     dir_tooltip="Template directory tooltip",
                     button_tooltip="Select template button tooltip",
                     is_template_selection=True,
+                    connected_fc_vehicle_type="ArduCopter",
                 )
 
                 # Call the method to select a template
@@ -250,6 +252,7 @@ def test_directory_selection_widgets_autoresize_width(base_parent, root) -> None
             dir_tooltip="Tooltip",
             button_tooltip="Button tooltip",
             is_template_selection=False,
+            connected_fc_vehicle_type="ArduCopter",
         )
 
         # Test with autoresize_width=False
@@ -262,6 +265,7 @@ def test_directory_selection_widgets_autoresize_width(base_parent, root) -> None
             dir_tooltip="Another tooltip",
             button_tooltip="Another button tooltip",
             is_template_selection=False,
+            connected_fc_vehicle_type="ArduCopter",
         )
 
         # Verify the difference in behavior when selecting a directory
@@ -297,6 +301,7 @@ def test_directory_selection_widgets_extremely_long_path(base_parent, root) -> N
             dir_tooltip="Test tooltip",
             button_tooltip="Button tooltip",
             is_template_selection=False,
+            connected_fc_vehicle_type="ArduCopter",
         )
 
         # Create an extremely long path
@@ -335,6 +340,7 @@ def test_directory_selection_widgets_special_characters(base_parent, root) -> No
             dir_tooltip="Test tooltip",
             button_tooltip="Button tooltip",
             is_template_selection=False,
+            connected_fc_vehicle_type="ArduCopter",
         )
 
         # Test with paths containing special characters
@@ -1165,11 +1171,19 @@ def test_create_option1_widgets(root, photo_patcher, icon_patcher, mock_local_fi
                                 with patch.object(window, "create_option1_widgets", mock_create_option1):
                                     # Call the method via the patched object
                                     window.create_option1_widgets(
-                                        "/template/dir", "/base/dir", "vehicle_name", fc_connected=True
+                                        "/template/dir",
+                                        "/base/dir",
+                                        "vehicle_name",
+                                        fc_connected=True,
+                                        connected_fc_vehicle_type="ArduCopter",
                                     )
                                     # Verify it was called with the correct arguments
                                     mock_create_option1.assert_called_once_with(
-                                        "/template/dir", "/base/dir", "vehicle_name", fc_connected=True
+                                        "/template/dir",
+                                        "/base/dir",
+                                        "vehicle_name",
+                                        fc_connected=True,
+                                        connected_fc_vehicle_type="ArduCopter",
                                     )
 
 
@@ -1203,6 +1217,7 @@ def test_ui_interaction_directory_selection_widgets() -> None:
                     dir_tooltip="Test tooltip",
                     button_tooltip="Select directory",
                     is_template_selection=True,
+                    connected_fc_vehicle_type="ArduCopter",
                 )
 
                 # Verify initial state

tests/test_frontend_tkinter_directory_selection_integration.py

@@ -345,6 +345,7 @@ def test_directory_selection_widgets_interaction(root: tk.Tk, monkeypatch: pytes
                     dir_tooltip="Test tooltip",
                     button_tooltip="Select directory",
                     is_template_selection=False,
+                    connected_fc_vehicle_type="ArduCopter",
                 )
 
                 # Update UI
@@ -383,6 +384,7 @@ def test_keyboard_navigation(root: tk.Tk, monkeypatch: pytest.MonkeyPatch) -> No
                 dir_tooltip="Test tooltip",
                 button_tooltip="Test button tooltip",
                 is_template_selection=False,
+                connected_fc_vehicle_type="ArduCopter",
             )
 
             # Ensure widgets are created and displayed