FEATURE: Automaticaly use vehicle and version dependent apm.pdef.xml URLs

Author: amilcarlucas

MethodicConfigurator/ardupilot_methodic_configurator.py

@@ -123,7 +123,8 @@ def main():
         FlightControllerInfoWindow(flight_controller)
 
     try:
-        local_filesystem = LocalFilesystem(args.vehicle_dir, vehicle_type, args.allow_editing_template_files)
+        local_filesystem = LocalFilesystem(args.vehicle_dir, vehicle_type, flight_controller.info.flight_sw_version,
+                                           args.allow_editing_template_files)
     except SystemExit as exp:
         show_error_message("Fatal error reading parameter files", f"{exp}")
         raise

MethodicConfigurator/backend_filesystem.py

@@ -94,10 +94,11 @@ class LocalFilesystem(VehicleComponents, ConfigurationSteps):  # pylint: disable
         param_default_dict (dict): A dictionary of default parameter values.
         doc_dict (dict): A dictionary containing documentation for each parameter.
     """
-    def __init__(self, vehicle_dir: str, vehicle_type: str, allow_editing_template_files: bool = False):
+    def __init__(self, vehicle_dir: str, vehicle_type: str, fw_version: str, allow_editing_template_files: bool):
         self.file_parameters = None
         VehicleComponents.__init__(self)
         ConfigurationSteps.__init__(self, vehicle_dir, vehicle_type)
+        self.fw_version = fw_version
         self.allow_editing_template_files = allow_editing_template_files
         if vehicle_dir is not None:
             self.re_init(vehicle_dir, vehicle_type)
@@ -119,7 +120,23 @@ def re_init(self, vehicle_dir: str, vehicle_type: str):
 
         # Read ArduPilot parameter documentation
         xml_dir = vehicle_dir if os_path.isdir(vehicle_dir) else os_path.dirname(os_path.realpath(vehicle_dir))
-        xml_root, self.param_default_dict = get_xml_data(BASE_URL + vehicle_type + "/", xml_dir, PARAM_DEFINITION_XML_FILE)
+        vehicle_parm_subdir = {
+            "ArduCopter": "versioned/Copter/stable-",
+            "ArduPlane": "versioned/Plane/stable-",
+            "Rover": "versioned/Rover/stable-",
+            "ArduSub": "versioned/Sub/stable-",
+            "AntennaTracker": "versioned/Tracker/stable-",
+            # Not yet versioned in the https://autotest.ardupilot.org/Parameters server
+            'AP_Periph': 'versioned/Periph/stable-',
+            'Blimp': 'versioned/Blimp/stable-',
+            'Heli': 'versioned/Heli/stable-',
+            'SITL': 'versioned/SITL/stable-'
+        }
+        if self.fw_version:
+            xml_url = BASE_URL + vehicle_parm_subdir[vehicle_type] + self.fw_version + "/"
+        else:
+            xml_url = BASE_URL + vehicle_type + "/"
+        xml_root, self.param_default_dict = get_xml_data(xml_url, xml_dir, PARAM_DEFINITION_XML_FILE)
         self.doc_dict = create_doc_dict(xml_root, vehicle_type, TOOLTIP_MAX_LENGTH)
 
         self.__extend_and_reformat_parameter_documentation_metadata()

MethodicConfigurator/frontend_tkinter_component_editor.py

@@ -425,6 +425,6 @@ def validate_data(self):  # pylint: disable=too-many-branches
 
     logging_basicConfig(level=logging_getLevelName(args.loglevel), format='%(asctime)s - %(levelname)s - %(message)s')
 
-    filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, args.allow_editing_template_files)
+    filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, None, args.allow_editing_template_files)
     app = ComponentEditorWindow(VERSION, filesystem)
     app.root.mainloop()

MethodicConfigurator/frontend_tkinter_component_editor_base.py

@@ -199,6 +199,6 @@ def add_argparse_arguments(parser):
 
     logging_basicConfig(level=logging_getLevelName(args.loglevel), format='%(asctime)s - %(levelname)s - %(message)s')
 
-    filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, args.allow_editing_template_files)
+    filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, None, args.allow_editing_template_files)
     app = ComponentEditorWindowBase(VERSION, filesystem)
     app.root.mainloop()

MethodicConfigurator/frontend_tkinter_directory_selection.py

@@ -412,7 +412,7 @@ def main():
     logging_warning("This main is for testing and development only, usually the VehicleDirectorySelectionWindow is"
                     " called from another script")
 
-    local_filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, args.allow_editing_template_files)
+    local_filesystem = LocalFilesystem(args.vehicle_dir, args.vehicle_type, None, args.allow_editing_template_files)
 
     # Get the list of intermediate parameter files files that will be processed sequentially
     files = list(local_filesystem.file_parameters.keys())

MethodicConfigurator/frontend_tkinter_template_overview.py

@@ -147,7 +147,7 @@ def main():
     vehicle_type = "ArduCopter"
 
     try:
-        local_filesystem = LocalFilesystem(args.vehicle_dir, vehicle_type, args.allow_editing_template_files)
+        local_filesystem = LocalFilesystem(args.vehicle_dir, vehicle_type, None, args.allow_editing_template_files)
     except SystemExit as expt:
         show_error_message("Fatal error reading parameter files", f"{expt}")
         raise

unittests/backend_filesystem_test.py

@@ -32,7 +32,7 @@ def test_read_params_from_files(self, mock_listdir, mock_isdir):
         LocalFilesystem.load_param_file_into_dict = mock_load_param_file_into_dict
 
         # Call the method under test
-        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type')
+        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type', None, False)
         result = lfs.read_params_from_files()
 
         # Assertions
@@ -42,7 +42,7 @@ def test_read_params_from_files(self, mock_listdir, mock_isdir):
         mock_load_param_file_into_dict.assert_called_once_with('vehicle_dir/02_test.param')
 
     def test_str_to_bool(self):
-        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type')
+        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type', None, False)
         self.assertTrue(lfs.str_to_bool('true'))
         self.assertTrue(lfs.str_to_bool('yes'))
         self.assertTrue(lfs.str_to_bool('1'))
@@ -59,7 +59,7 @@ def test_re_init(self, mock_read_params_from_files, mock_listdir, mock_isdir):
         mock_listdir.return_value = ['00_default.param', '01_ignore_readonly.param', '02_test.param']
         mock_read_params_from_files.return_value = {'02_test.param': {'TEST_PARAM': 'value'}}
 
-        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type')
+        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type', None, False)
         lfs.re_init('new_vehicle_dir', 'new_vehicle_type')
 
         self.assertEqual(lfs.vehicle_dir, 'new_vehicle_dir')
@@ -70,7 +70,7 @@ def test_re_init(self, mock_read_params_from_files, mock_listdir, mock_isdir):
 
     def test_write_summary_files(self):
         # Initialize LocalFilesystem with the test directory
-        # lfs = LocalFilesystem(self.test_dir, "vehicle_type")
+        # lfs = LocalFilesystem(self.test_dir, "vehicle_type", None, False)
 
         # Call the method under test
         # Assuming you have a method to write summary files
@@ -98,7 +98,7 @@ def test_copy_template_files_to_new_vehicle_dir(self, mock_copy2, mock_copytree,
         mock_join.side_effect = lambda *args: '/'.join(args)
 
         # Initialize LocalFilesystem
-        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type')
+        lfs = LocalFilesystem('vehicle_dir', 'vehicle_type', None, False)
 
         # Call the method under test
         lfs.copy_template_files_to_new_vehicle_dir('template_dir', 'new_vehicle_dir')