ardupilot-methodic-configurator 1.4.2__tar.gz → 1.4.4__tar.gz

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ardupilot_methodic_configurator
-Version: 1.4.2
+Version: 1.4.4
 Summary: A clear configuration sequence for ArduPilot vehicles
 Author-email: Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 Maintainer-email: Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
@@ -38,33 +38,35 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: argcomplete==3.6.1
+Requires-Dist: argcomplete==3.6.2
 Requires-Dist: defusedxml==0.7.1
 Requires-Dist: jsonschema==4.23.0
 Requires-Dist: matplotlib==3.9.4
 Requires-Dist: numpy==2.0.2
-Requires-Dist: pillow==11.1.0
+Requires-Dist: pillow==11.2.1
 Requires-Dist: pip_system_certs==4.0
 Requires-Dist: platformdirs==4.3.7
 Requires-Dist: pymavlink==2.4.43
 Requires-Dist: pyserial==3.5
 Requires-Dist: requests==2.32.3
-Requires-Dist: setuptools==78.1.0
+Requires-Dist: setuptools==79.0.0
 Provides-Extra: dev
 Requires-Dist: coverage==7.8.0; extra == "dev"
 Requires-Dist: mock==5.2.0; extra == "dev"
 Requires-Dist: mypy==1.15.0; extra == "dev"
-Requires-Dist: pre-commit==4.1.0; extra == "dev"
-Requires-Dist: pyinstaller==6.12.0; extra == "dev"
+Requires-Dist: pre-commit==4.2.0; extra == "dev"
+Requires-Dist: pyinstaller==6.13.0; extra == "dev"
 Requires-Dist: pylint==3.3.6; extra == "dev"
-Requires-Dist: pyright==1.1.396; extra == "dev"
+Requires-Dist: pyright==1.1.399; extra == "dev"
 Requires-Dist: pytest==8.3.5; extra == "dev"
-Requires-Dist: pytest-cov==6.0.0; extra == "dev"
+Requires-Dist: pytest-cov==6.1.1; extra == "dev"
 Requires-Dist: pytest-md==0.2.0; extra == "dev"
 Requires-Dist: pytest-mock==3.14.0; extra == "dev"
 Requires-Dist: python-gettext==5.0; extra == "dev"
-Requires-Dist: ruff==0.11.2; extra == "dev"
+Requires-Dist: ruff==0.11.6; extra == "dev"
 Requires-Dist: types-requests==2.32.0.20250328; extra == "dev"
+Provides-Extra: scripts
+Requires-Dist: bs4; extra == "scripts"
 Dynamic: license-file
 
 # Correctly configure ArduPilot for your vehicles on your first attempt

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/__init__.py

@@ -12,4 +12,4 @@ from ardupilot_methodic_configurator.internationalization import load_translatio
 
 _ = load_translation()
 
-__version__ = "1.4.2"
+__version__ = "1.4.4"

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/backend_filesystem_vehicle_components.py

@@ -455,15 +455,16 @@ class VehicleComponents:
             elif isinstance(value, list):
                 # If it's a list, preserve it but empty it
                 data[key] = []
-            elif isinstance(value, (int, float)):
-                # For numerical values, set to 0
-                data[key] = 0 if isinstance(value, int) else 0.0
             elif isinstance(value, bool):
-                # For boolean values, set to False
                 data[key] = False
+            elif isinstance(value, int):
+                data[key] = 0
+            elif isinstance(value, float):
+                data[key] = 0.0
+            elif isinstance(value, str):
+                data[key] = ""
             else:
-                # For strings and other types, set to empty string or None
-                data[key] = "" if isinstance(value, str) else None
+                data[key] = None
 
     def get_component_property_description(self, path: tuple[str, ...]) -> tuple[str, bool]:
         """

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/backend_flightcontroller.py

@@ -288,7 +288,36 @@ class FlightController:
             if log_errors:
                 logging_warning(_("Connection failed: %s"), e)
                 logging_error(_("Failed to connect after %d attempts."), retries)
-            return str(e)
+            error_message = str(e)
+            guidance = self.__get_connection_error_guidance(e, self.comport.device if self.comport else "")
+            if guidance:
+                error_message = f"{error_message}\n\n{guidance}"
+            return error_message
+
+    def __get_connection_error_guidance(self, error: Exception, device: str) -> str:
+        """
+        Provides guidance based on the type of connection error.
+
+        Args:
+            error (Exception): The exception that occurred during connection.
+            device (str): The device path or connection string.
+
+        Returns:
+            str: Guidance message specific to the error type, or empty string if no specific guidance.
+
+        """
+        # Check for permission denied errors on Linux
+        if isinstance(error, PermissionError) and os_name == "posix" and "/dev/" in device:
+            return _(
+                "Permission denied accessing the serial port. This is common on Linux systems.\n"
+                "To fix this issue, add your user to the 'dialout' group with the following command:\n"
+                "    sudo adduser $USER dialout\n"
+                "Then log out and log back in for the changes to take effect."
+            )
+
+        # Add more specific guidance for other error types as needed
+
+        return ""
 
     def __process_autopilot_version(self, m: MAVLink_autopilot_version_message, banner_msgs: list[str]) -> str:
         if m is None:

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/frontend_tkinter_directory_selection.py

@@ -89,7 +89,8 @@ class DirectorySelectionWidgets:
     def on_select_directory(self) -> bool:
         if self.is_template_selection:
             if isinstance(self.parent.root, tk.Tk):  # this keeps mypy and pyright happy
-                TemplateOverviewWindow(self.parent.root)
+                to = TemplateOverviewWindow(self.parent.root)
+                to.run_app()
             selected_directory = ProgramSettings.get_recently_used_dirs()[0]
             logging_info(_("Selected template directory: %s"), selected_directory)
         else:

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/frontend_tkinter_parameter_editor_table.py

@@ -182,12 +182,10 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
         try:
             for i, (param_name, param) in enumerate(params.items(), 1):
                 current_param_name = param_name
-                param_metadata = self.local_filesystem.doc_dict.get(param_name, None)
+                param_metadata = self.local_filesystem.doc_dict.get(param_name, {})
                 param_default = self.local_filesystem.param_default_dict.get(param_name, None)
-                doc_tooltip = (
-                    param_metadata.get("doc_tooltip")
-                    if param_metadata
-                    else _("No documentation available in apm.pdef.xml for this parameter")
+                doc_tooltip = param_metadata.get(
+                    "doc_tooltip", _("No documentation available in apm.pdef.xml for this parameter")
                 )
 
                 column: list[tk.Widget] = []
@@ -240,8 +238,8 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
         return delete_button
 
     def __create_parameter_name(self, param_name: str, param_metadata: dict[str, Any], doc_tooltip: str) -> ttk.Label:
-        is_calibration = param_metadata.get("Calibration", False) if param_metadata else False
-        is_readonly = param_metadata.get("ReadOnly", False) if param_metadata else False
+        is_calibration = param_metadata.get("Calibration", False)
+        is_readonly = param_metadata.get("ReadOnly", False)
         parameter_label = ttk.Label(
             self.view_port,
             text=param_name + (" " * (16 - len(param_name))),
@@ -308,6 +306,7 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
     ) -> Union[PairTupleCombobox, ttk.Entry]:
         is_bitmask = param_metadata and "Bitmask" in param_metadata
         present_as_forced = False
+        present_as_derived = False
         if (
             self.current_file in self.local_filesystem.forced_parameters
             and param_name in self.local_filesystem.forced_parameters[self.current_file]
@@ -321,7 +320,7 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
             self.current_file in self.local_filesystem.derived_parameters
             and param_name in self.local_filesystem.derived_parameters[self.current_file]
         ):
-            present_as_forced = True
+            present_as_derived = True
             new_value = self.local_filesystem.derived_parameters[self.current_file][param_name].value
             if (is_bitmask and param.value != new_value) or not is_within_tolerance(param.value, new_value):
                 param.value = new_value
@@ -344,7 +343,7 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
                 value_str,
                 param_name,
                 style="TCombobox"
-                if present_as_forced
+                if present_as_forced or present_as_derived
                 else "default_v.TCombobox"
                 if has_default_value
                 else "readonly.TCombobox",
@@ -367,8 +366,30 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
         except KeyError as e:
             logging_critical(_("Parameter %s not found in the %s file: %s"), param_name, self.current_file, e, exc_info=True)
             sys_exit(1)
-        if present_as_forced:
+
+        # Store error messages for forced and derived parameters
+        forced_error_msg = _(
+            "This parameter already has the correct value for this configuration step.\n"
+            "You must not change it, as this would defeat the purpose of this configuration step.\n\n"
+            "Add it to other configuration step and change it there if you have a good reason to."
+        )
+        derived_error_msg = _(
+            "This parameter value has been derived from information you entered in the component editor window.\n"
+            "You need to change the information on that window to update the value here.\n"
+        )
+
+        # Function to show the appropriate error message
+        def show_parameter_error(_event: tk.Event) -> None:  # pylint: disable=unused-argument
+            if present_as_forced:
+                messagebox.showerror(_("Forced Parameter"), forced_error_msg)
+            elif present_as_derived:
+                messagebox.showerror(_("Derived Parameter"), derived_error_msg)
+
+        if present_as_forced or present_as_derived:
             new_value_entry.config(state="disabled", background="light grey")
+            new_value_entry.bind("<Button-1>", show_parameter_error)
+            # Also bind to right-click for completeness
+            new_value_entry.bind("<Button-3>", show_parameter_error)
         elif bitmask_dict:
             new_value_entry.bind(
                 "<Double-Button>",
@@ -472,11 +493,9 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
         window.wait_window()  # Wait for the window to be closed
 
     def __create_unit_label(self, param_metadata: dict[str, Union[float, str]]) -> ttk.Label:
-        unit_label = ttk.Label(self.view_port, text=param_metadata.get("unit", "") if param_metadata else "")
+        unit_label = ttk.Label(self.view_port, text=param_metadata.get("unit", ""))
         unit_tooltip = str(
-            param_metadata.get("unit_tooltip")
-            if param_metadata
-            else _("No documentation available in apm.pdef.xml for this parameter")
+            param_metadata.get("unit_tooltip", _("No documentation available in apm.pdef.xml for this parameter"))
         )
         if unit_tooltip:
             show_tooltip(unit_label, unit_tooltip)
@@ -640,9 +659,9 @@ class ParameterEditorTable(ScrollFrame):  # pylint: disable=too-many-ancestors
         try:
             p = float(new_value)  # type: ignore[arg-type] # workaround a mypy bug
             changed = not is_within_tolerance(old_value, p)
-            param_metadata = self.local_filesystem.doc_dict.get(param_name, None)
-            p_min = param_metadata.get("min", None) if param_metadata else None
-            p_max = param_metadata.get("max", None) if param_metadata else None
+            param_metadata = self.local_filesystem.doc_dict.get(param_name, {})
+            p_min = param_metadata.get("min", None)
+            p_max = param_metadata.get("max", None)
             if changed:
                 if p_min and p < p_min:
                     msg = _("The value for {param_name} {p} should be greater than {p_min}\n")

{ardupilot_methodic_configurator-1.4.2 → ardupilot_methodic_configurator-1.4.4}/ardupilot_methodic_configurator/frontend_tkinter_template_overview.py

@@ -13,8 +13,9 @@ SPDX-License-Identifier: GPL-3.0-or-later
 import argparse
 import tkinter as tk
 from logging import basicConfig as logging_basicConfig
-from logging import debug as logging_debug
 from logging import getLevelName as logging_getLevelName
+from logging import info as logging_info
+from tkinter import font as tkfont
 from tkinter import ttk
 from typing import Optional
 
@@ -39,14 +40,20 @@ class TemplateOverviewWindow(BaseWindow):
 
     Attributes:
         window (tk.Tk|None): The root Tkinter window object for the GUI.
-
-    Methods:
-        on_row_double_click(event): Handles the event triggered when a row in the Treeview is double-clicked, allowing the user
-                                     to store the corresponding template directory.
+        sort_column (str): The column currently being used for sorting
+        tree (ttk.Treeview): The treeview widget displaying templates
+        image_label (ttk.Label): Label for displaying vehicle images
 
     """
 
     def __init__(self, parent: Optional[tk.Tk] = None) -> None:
+        """
+        Initialize the TemplateOverviewWindow.
+
+        Args:
+            parent: Optional parent Tk window
+
+        """
         super().__init__(parent)
         title = _("Amilcar Lucas's - ArduPilot methodic configurator {} - Template Overview and selection")
         self.root.title(title.format(__version__))
@@ -63,8 +70,24 @@ class TemplateOverviewWindow(BaseWindow):
         self.image_label = ttk.Label(self.top_frame)
         self.image_label.pack(side=tk.RIGHT, anchor=tk.NE, padx=(20, 20), pady=IMAGE_HEIGHT_PX / 2)
 
-        self.sort_column: str
+        self.sort_column: str = ""
+        self._setup_treeview()
+        self._bind_events()
+
+    def run_app(self) -> None:
+        """Run the TemplateOverviewWindow application."""
+        if isinstance(self.root, tk.Toplevel):
+            try:
+                while self.root.children:
+                    self.root.update_idletasks()
+                    self.root.update()
+            except tk.TclError as _exp:
+                pass
+        elif isinstance(self.root, tk.Tk):
+            self.root.mainloop()
 
+    def _setup_treeview(self) -> None:
+        """Set up the treeview with columns and styling."""
         style = ttk.Style(self.root)
         # Add padding to Treeview heading style
         style.layout(
@@ -99,76 +122,87 @@ class TemplateOverviewWindow(BaseWindow):
         for col in columns:
             self.tree.heading(col, text=col)
 
-        # Populate the Treeview with data from the template overview
+        self._populate_treeview()
+        self._adjust_treeview_column_widths()
+        self.tree.pack(fill=tk.BOTH, expand=True)
+
+    def _populate_treeview(self) -> None:
+        """Populate the treeview with data from vehicle components."""
         for key, template_overview in VehicleComponents.get_vehicle_components_overviews().items():
             attribute_names = template_overview.attributes()
             values = (key, *(getattr(template_overview, attr, "") for attr in attribute_names))
             self.tree.insert("", "end", text=key, values=values)
 
-        self._adjust_treeview_column_widths()
-
-        self.tree.bind("<ButtonRelease-1>", self.__on_row_selection_change)
-        self.tree.bind("<Up>", self.__on_row_selection_change)
-        self.tree.bind("<Down>", self.__on_row_selection_change)
-        self.tree.bind("<Double-1>", self.__on_row_double_click)
-        self.tree.pack(fill=tk.BOTH, expand=True)
-
-        for col in self.tree["columns"]:
-            col_str = str(col)
-            self.tree.heading(
-                col_str,
-                text=col_str,
-                command=lambda col2=col_str: self.__sort_by_column(col2, reverse=False),  # type: ignore[misc]
-            )
-
-        if isinstance(self.root, tk.Toplevel):
-            try:
-                while self.root.children:
-                    self.root.update_idletasks()
-                    self.root.update()
-            except tk.TclError as _exp:
-                pass
-        else:
-            self.root.mainloop()
-
     def _adjust_treeview_column_widths(self) -> None:
         """Adjusts the column widths of the Treeview to fit the contents of each column."""
         for col in self.tree["columns"]:
             max_width = 0
             for subtitle in col.title().split("\n"):
-                max_width = max(max_width, tk.font.Font().measure(subtitle))  # pyright: ignore[reportAttributeAccessIssue]
+                max_width = max(max_width, tkfont.Font().measure(subtitle))
 
             # Iterate over all rows and update the max_width if a wider entry is found
             for item in self.tree.get_children():
                 item_text = self.tree.item(item, "values")[self.tree["columns"].index(col)]
-                text_width = tk.font.Font().measure(item_text)  # pyright: ignore[reportAttributeAccessIssue]
+                text_width = tkfont.Font().measure(item_text)
                 max_width = max(max_width, text_width)
 
             # Update the column's width property to accommodate the largest text width
             self.tree.column(col, width=int(max_width * 0.6 + 10))
 
-    def __on_row_selection_change(self, _event: tk.Event) -> None:
+    def _bind_events(self) -> None:
+        """Bind events to the treeview."""
+        self.tree.bind("<ButtonRelease-1>", self._on_row_selection_change)
+        self.tree.bind("<Up>", self._on_row_selection_change)
+        self.tree.bind("<Down>", self._on_row_selection_change)
+        self.tree.bind("<Double-1>", self._on_row_double_click)
+
+        for col in self.tree["columns"]:
+            col_str = str(col)
+            self.tree.heading(
+                col_str,
+                text=col_str,
+                command=lambda col2=col_str: self._sort_by_column(col2, reverse=False),  # type: ignore[misc]
+            )
+
+    def _on_row_selection_change(self, _event: tk.Event) -> None:
         """Handle row single-click event."""
-        self.root.after(0, self.__update_selection)
+        self.root.after(0, self._update_selection)
 
-    def __update_selection(self) -> None:
+    def _update_selection(self) -> None:
         """Update selection after keypress event."""
         selected_item = self.tree.selection()
         if selected_item:
             item_id = selected_item[0]
             selected_template_relative_path = self.tree.item(item_id)["text"]
-            ProgramSettings.store_template_dir(selected_template_relative_path)
+            self.store_template_dir(selected_template_relative_path)
             self._display_vehicle_image(selected_template_relative_path)
 
-    def __on_row_double_click(self, event: tk.Event) -> None:
+    def store_template_dir(self, template_path: str) -> None:
+        """
+        Store the selected template directory.
+
+        This method is separated from the UI event handler to improve testability.
+
+        Args:
+            template_path: The path to store
+
+        """
+        ProgramSettings.store_template_dir(template_path)
+
+    def _on_row_double_click(self, event: tk.Event) -> None:
         """Handle row double-click event."""
         item_id = self.tree.identify_row(event.y)
         if item_id:
             selected_template_relative_path = self.tree.item(item_id)["text"]
-            ProgramSettings.store_template_dir(selected_template_relative_path)
-            self.root.destroy()
+            self.store_template_dir(selected_template_relative_path)
+            self.close_window()
+
+    def close_window(self) -> None:
+        """Close the window - separated for testability."""
+        self.root.destroy()
 
-    def __sort_by_column(self, col: str, reverse: bool) -> None:
+    def _sort_by_column(self, col: str, reverse: bool) -> None:
+        """Sort treeview items by the specified column."""
         if hasattr(self, "sort_column") and self.sort_column and self.sort_column != col:
             self.tree.heading(self.sort_column, text=self.sort_column)
         self.tree.heading(col, text=col + (" ▼" if reverse else " ▲"))
@@ -185,7 +219,7 @@ class TemplateOverviewWindow(BaseWindow):
             self.tree.move(k, "", index)
 
         # reverse sort next time
-        self.tree.heading(col, command=lambda: self.__sort_by_column(col, not reverse))
+        self.tree.heading(col, command=lambda: self._sort_by_column(col, not reverse))
 
     def _display_vehicle_image(self, template_path: str) -> None:
         """Display the vehicle image corresponding to the selected template."""
@@ -194,7 +228,7 @@ class TemplateOverviewWindow(BaseWindow):
             if isinstance(widget, ttk.Label) and widget == self.image_label:
                 widget.destroy()
         try:
-            vehicle_image_filepath = VehicleComponents.get_vehicle_image_filepath(template_path)
+            vehicle_image_filepath = self.get_vehicle_image_filepath(template_path)
             self.image_label = self.put_image_in_label(self.top_frame, vehicle_image_filepath, IMAGE_HEIGHT_PX)
         except FileNotFoundError:
             self.image_label = ttk.Label(
@@ -204,6 +238,24 @@ class TemplateOverviewWindow(BaseWindow):
             )
         self.image_label.pack(side=tk.RIGHT, anchor=tk.NE, padx=(4, 0), pady=(0, 0))
 
+    def get_vehicle_image_filepath(self, template_path: str) -> str:
+        """
+        Get the filepath for a vehicle image.
+
+        Separated from display method for testability.
+
+        Args:
+            template_path: Path to the template
+
+        Returns:
+            Path to the vehicle image
+
+        Raises:
+            FileNotFoundError: If the image file doesn't exist
+
+        """
+        return VehicleComponents.get_vehicle_image_filepath(template_path)
+
 
 def argument_parser() -> argparse.Namespace:
     """
@@ -217,25 +269,38 @@ def argument_parser() -> argparse.Namespace:
     """
     parser = argparse.ArgumentParser(
         description=_(
-            "ArduPilot methodic configurator is a GUI-based tool designed to simplify "
-            "the management and visualization of ArduPilot parameters. It enables users "
-            "to browse through various vehicle templates, edit parameter files, and "
-            "apply changes directly to the flight controller. The tool is built to "
-            "semi-automate the configuration process of ArduPilot for drones by "
-            "providing a clear and intuitive interface for parameter management."
+            "ArduPilot Template Overview - A component of the ArduPilot Methodic Configurator suite. "
+            "This tool presents available vehicle templates in a user-friendly interface, allowing you "
+            "to browse, compare, and select the most appropriate template for your vehicle configuration. "
+            "Select a template that most closely resembles your vehicle's component setup to streamline "
+            "the configuration process. The selected template will serve as a starting point for more "
+            "detailed parameter configuration."
         )
     )
     return add_common_arguments(parser).parse_args()
 
 
+def setup_logging(loglevel: str) -> None:
+    """
+    Set up logging with the specified log level.
+
+    Args:
+        loglevel: The log level as a string (e.g. 'DEBUG', 'INFO')
+
+    """
+    logging_basicConfig(level=logging_getLevelName(loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
+
+
 def main() -> None:
+    """Main entry point for the application."""
     args = argument_parser()
+    setup_logging(args.loglevel)
 
-    logging_basicConfig(level=logging_getLevelName(args.loglevel), format="%(asctime)s - %(levelname)s - %(message)s")
-
-    TemplateOverviewWindow(None)
+    window = TemplateOverviewWindow()
+    window.run_app()
 
-    logging_debug(ProgramSettings.get_recently_used_dirs()[0])
+    if window and ProgramSettings.get_recently_used_dirs():
+        logging_info(ProgramSettings.get_recently_used_dirs()[0])
 
 
 if __name__ == "__main__":