fix: Auto import params

Signed-off-by: Omkar Sarkar <omkarsarkar24@gmail.com>

Author: OmkarSarkar204

USERMANUAL.md

@@ -421,6 +421,10 @@ These files are crucial for the tool's operation and are organized in a specific
   The `configuration_steps_ArduCopter.json` documentation file is first searched in the selected vehicle-specific directory,
   and if not found, in the directory where the script is located.
 
+- **Configuration Steps File**: The `configuration_steps_*.json` files (like `configuration_steps_ArduCopter.json`) define the workflow,
+ for each intermediate parameter file. They provide the documentation links, explanations("why" and "why now"), mandatory/optional percentages,
+ and advanced logic rules like `autoimport_nondefault_regexp` to automatically pull specific non-default parameters from the live flight controller into the GUI.
+
 - **Default Parameter Values File**: The `00_defaults.param` file is located in the vehicle-specific directory.
   If the file does not exist or is invalid, use this command to regenerate it
 

ardupilot_methodic_configurator/configuration_steps_ArduCopter.json

@@ -124,6 +124,7 @@
             "external_tool_url": "",
             "mandatory_text": "100% mandatory (0% optional)",
             "auto_changed_by": "",
+            "autoimport_nondefault_regexp": ["BATT.*"],
             "forced_parameters": {
                 "BATT_FS_CRT_ACT": { "New Value": 1, "Change Reason": "Land ASAP" },
                 "BATT_FS_LOW_ACT": { "New Value": 2, "Change Reason": "Return and land at home or rally point" }
@@ -169,6 +170,7 @@
             "external_tool_url": "",
             "mandatory_text": "100% mandatory (0% optional)",
             "auto_changed_by": "",
+            "autoimport_nondefault_regexp": ["GPS.*", "GNSS.*"],
             "derived_parameters": {
                 "GPS_TYPE": { "New Value": "vehicle_components['GNSS Receiver']['FC Connection']['Protocol']", "Change Reason": "Defined in component editor" },
                 "GPS1_TYPE": { "New Value": "vehicle_components['GNSS Receiver']['FC Connection']['Protocol']", "Change Reason": "Defined in component editor" }

ardupilot_methodic_configurator/configuration_steps_schema.json

@@ -23,6 +23,13 @@
               "type": "string",
               "description": "Explanation of why this step is needed"
             },
+            "autoimport_nondefault_regexp": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "A list of regular expressions to match parameters for automatic import if they have non-default values."
+            },
             "why_now": {
               "type": "string",
               "description": "Explanation of why this step needs to be done at this point"

ardupilot_methodic_configurator/configuration_steps_strings.py

@@ -344,6 +344,9 @@ def configuration_steps_descriptions() -> None:
 
     For pygettext to extract them, they have no other function
     """
+    _config_steps_descriptions = _(
+        "A list of regular expressions to match parameters for automatic import if they have non-default values."
+    )
     _config_steps_descriptions = _("Description of the phase")
     _config_steps_descriptions = _("Explanation of why this step is needed")
     _config_steps_descriptions = _("Explanation of why this step needs to be done at this point")

ardupilot_methodic_configurator/data_model_configuration_step.py

@@ -11,13 +11,14 @@
 SPDX-License-Identifier: GPL-3.0-or-later
 """
 
+import re
 from logging import info as logging_info
 from typing import Any, Optional
 
 from ardupilot_methodic_configurator import _
 from ardupilot_methodic_configurator.backend_filesystem import LocalFilesystem
 from ardupilot_methodic_configurator.data_model_ardupilot_parameter import ArduPilotParameter
-from ardupilot_methodic_configurator.data_model_par_dict import Par, ParDict
+from ardupilot_methodic_configurator.data_model_par_dict import Par, ParDict, is_within_tolerance
 from ardupilot_methodic_configurator.data_model_safe_evaluator import safe_evaluate
 
 
@@ -100,10 +101,10 @@ def process_configuration_step(  # pylint: disable=too-many-locals
             # Collect derived parameter values to apply later in domain model
             elif selected_file in self.local_filesystem.derived_parameters:
                 # Filter derived parameters that exist in FC (if fc_parameters provided)
-                fc_param_names = set(fc_parameters.keys()) if fc_parameters else set()
+                fc_param_keys = set(fc_parameters.keys()) if fc_parameters else set()
                 for param_name, param in self.local_filesystem.derived_parameters[selected_file].items():
                     # Only include if no FC filter OR parameter exists in FC
-                    if not fc_param_names or param_name in fc_param_names:
+                    if not fc_param_keys or param_name in fc_param_keys:
                         derived_params_to_apply[param_name] = param
 
             # Populate new_connection_prefix from rename_connection configuration step (per-step scope)
@@ -123,6 +124,9 @@ def process_configuration_step(  # pylint: disable=too-many-locals
         # Create domain model parameters
         current_step_parameters = self._create_domain_model_parameters(selected_file, fc_parameters)
 
+        # Call the _apply_auto_imports import
+        self._apply_auto_imports(selected_file, fc_parameters, current_step_parameters)
+
         # Check for ExpressLRS and add FLTMODE_CH warning
         if current_step_parameters.get("RC_OPTIONS") is not None or current_step_parameters.get("FLTMODE_CH") is not None:
             rc_options = int(fc_parameters.get("RC_OPTIONS", 32))
@@ -142,6 +146,34 @@ def process_configuration_step(  # pylint: disable=too-many-locals
 
         return current_step_parameters, ui_errors, ui_infos, duplicates_to_remove, renames_to_apply, derived_params_to_apply
 
+    def _apply_auto_imports(
+        self,
+        selected_file: str,
+        fc_parameters: dict[str, float],
+        current_step_parameters: dict[str, ArduPilotParameter],
+    ) -> None:
+        """Automatically import non-default FC parameters matching regex rules into the domain model."""
+        step_dict = self.local_filesystem.configuration_steps.get(selected_file, {})
+        if "autoimport_nondefault_regexp" not in step_dict or not fc_parameters:
+            return
+
+        regex_rules = step_dict["autoimport_nondefault_regexp"]
+        for live_key, live_value in fc_parameters.items():
+            if live_key in current_step_parameters:
+                continue
+
+            is_matching_regex = any(re.match(pattern, live_key) for pattern in regex_rules)
+            is_in_defaults = live_key in self.local_filesystem.param_default_dict
+
+            if is_matching_regex and is_in_defaults:
+                default_value = self.local_filesystem.param_default_dict[live_key].value
+                if not is_within_tolerance(live_value, default_value):
+                    # Create the parameter with a blank reason and inject it into the UI domain model
+                    param = Par(float(live_value), "")
+                    current_step_parameters[live_key] = self.create_ardupilot_parameter(
+                        live_key, param, selected_file, fc_parameters
+                    )
+
     def _handle_connection_renaming(
         self, selected_file: str, variables: dict
     ) -> tuple[list[tuple[str, str]], set[str], list[tuple[str, str]]]:

tests/test_data_model_configuration_step.py

@@ -190,6 +190,56 @@ def test_user_receives_error_feedback_when_derived_parameter_computation_fails(
         # Should have info messages about parameter renaming since configuration includes rename_connection
         assert len(ui_infos) > 0
 
+    def test_user_can_auto_import_nondefault_parameters_matching_regex(self, processor) -> None:
+        """
+        User can automatically import non-default flight controller parameters that match regex rules.
+
+        GIVEN: A configuration step with auto-import regex rules
+        WHEN: The step is processed with live FC parameters
+        THEN: Non-default matching parameters are added to the domain model with a blank reason
+        AND: Parameters already in the file or matching firmware defaults are not overridden
+        """
+        # Arrange: Set up configuration with regex rules and mixed FC states
+        selected_file = "test_file.param"
+        processor.local_filesystem.configuration_steps = {selected_file: {"autoimport_nondefault_regexp": ["BATT.*", "GPS.*"]}}
+        processor.local_filesystem.param_default_dict = {
+            "BATT_OPTIONS": Par(value=0.0, comment="Default option"),
+            "BATT_MONITOR": Par(value=0.0, comment="Default monitor"),
+            "GPS_TYPE": Par(value=0.0, comment="Default type"),
+        }
+        processor.local_filesystem.file_parameters = {
+            selected_file: {
+                "BATT_MONITOR": Par(value=4.0, comment="User comment")  # Already exists in file
+            }
+        }
+        test_fc_parameters = {
+            "BATT_OPTIONS": 5.0,  # Non-default, matching regex -> MUST IMPORT
+            "BATT_MONITOR": 4.0,  # Already in file -> MUST SKIP
+            "GPS_TYPE": 0.0,  # Default value -> MUST SKIP
+            "SERIAL1_BAUD": 115200.0,  # Doesn't match regex -> MUST SKIP
+        }
+
+        # Act: Process configuration step
+        parameters, ui_errors, _, _, _, _ = processor.process_configuration_step(selected_file, test_fc_parameters)
+
+        # Assert: No errors
+        assert ui_errors == []
+
+        # BATT_OPTIONS should be auto-imported with a blank reason
+        assert "BATT_OPTIONS" in parameters
+        assert parameters["BATT_OPTIONS"].get_new_value() == 5.0
+        assert parameters["BATT_OPTIONS"].change_reason == ""
+
+        # BATT_MONITOR should remain untouched (protecting the user comment)
+        assert "BATT_MONITOR" in parameters
+        assert parameters["BATT_MONITOR"].change_reason == "User comment"
+
+        # GPS_TYPE should NOT be imported (it is at default value)
+        assert "GPS_TYPE" not in parameters
+
+        # SERIAL1_BAUD should NOT be imported (does not match regex)
+        assert "SERIAL1_BAUD" not in parameters
+
 
 class TestConfigurationStepProcessorConnectionRenaming:
     """Test connection renaming workflows and edge cases."""