FEATURE: Auto detect correct board name and if possible maufacturer.

Author: amilcarlucas

MethodicConfigurator/backend_flightcontroller_info.py

@@ -9,7 +9,7 @@
 """
 
 from collections.abc import Sequence
-from typing import Any, Union
+from typing import Union
 
 from pymavlink import mavutil
 
@@ -236,7 +236,7 @@ def __classify_vehicle_type(mav_type_int: int) -> str:
         return mav_type_to_vehicle_type.get(mav_type_int, "")
 
     @staticmethod
-    def __list_ardupilot_supported_usb_pid_vid() -> dict[int, dict[str, Any]]:
+    def __list_ardupilot_supported_usb_pid_vid() -> dict[int, dict[str, Union[str, dict[int, str]]]]:
         """
         List all ArduPilot supported USB vendor ID (VID) and product ID (PID).
 

update_flight_controller_ids.py

@@ -0,0 +1,219 @@
+#!/usr/bin/env python3
+
+"""
+Updates the USB VIDs and PIDs of the supported flight controllers.
+
+This file is part of Ardupilot methodic configurator. https://github.com/ArduPilot/MethodicConfigurator
+
+SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <[email protected]>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+"""
+
+import io  # Import io for StringIO
+import os
+import sys
+from typing import Union
+
+# Add ../ardupilot/libraries/AP_HAL_ChibiOS/hwdef/scripts to the PYTHON path
+scripts_path = os.path.abspath("../ardupilot/libraries/AP_HAL_ChibiOS/hwdef/scripts")
+init_file_path = os.path.join(scripts_path, "__init__.py")
+
+# Check if the __init__.py file exists
+if not os.path.exists(init_file_path):
+    # Create the __init__.py file
+    with open(init_file_path, "w") as init_file:
+        init_file.write("# This __init__.py was created automatically\n")
+    print(f"Created __init__.py at: {init_file_path}")
+else:
+    print(f"__init__.py already exists at: {init_file_path}")
+sys.path.append(scripts_path)
+
+try:
+    import chibios_hwdef
+
+    print("Module imported successfully.")
+except ImportError as e:
+    print(f"ImportError: {e}")
+
+
+# Define the base directory to crawl
+base_dir = "../ardupilot/libraries/AP_HAL_ChibiOS/hwdef/"
+
+# Define the search terms
+SEARCH_VENDOR_ID = "USB_VENDOR"
+SEARCH_VENDOR_STRING = "USB_STRING_MANUFACTURER"
+SEARCH_PRODUCT_ID = "USB_PRODUCT"
+SEARCH_PRODUCT_STRING = "USB_STRING_PRODUCT"
+APJ_BOARD_ID_SEARCH = "APJ_BOARD_ID"
+
+# Initialize the result dictionary
+result: dict[int, dict[str, Union[str, dict[int, str]]]] = {}
+apj_board_ids: dict[int, str] = {}
+apj_board_ids_bdshot: dict[int, str] = {}
+board_types: dict[str, int] = {}
+
+
+def read_board_types_txt(filepath: str = "../ardupilot/Tools/AP_Bootloader/board_types.txt") -> None:
+    try:
+        with open(filepath, encoding="utf-8") as file:
+            for line in file:
+                text = line.strip()
+                parts = text.split()
+                if len(parts) >= 2 and parts[0] not in {"#", ""}:
+                    board_types[parts[0]] = parts[1]
+    except Exception as e:
+        print(f"Error reading {filepath}: {e}")
+        return
+
+
+def search_hwdef_files(base_directory: str) -> None:
+    # Walk through the directory
+    for dirpath, _dirnames, filenames in os.walk(base_directory):
+        for filename in filenames:
+            if filename == "hwdef.dat":
+                hwdef_file_path = os.path.join(dirpath, filename)
+                dirname = os.path.basename(dirpath)
+                # process_hwdef_file(hwdef_file_path, dirname)
+                c = chibios_hwdef.ChibiOSHWDef(
+                    outdir="/tmp",  # noqa: S108
+                    bootloader=False,
+                    signed_fw=False,
+                    hwdef=[hwdef_file_path],
+                    default_params_filepath=None,
+                    quiet=True,
+                )
+                c.process_hwdefs()
+                numeric_board_id = int(c.get_numeric_board_id())
+                # print(f"{dirname} {c.get_numeric_board_id()}")
+                if "bdshot" in dirname:
+                    apj_board_ids_bdshot[numeric_board_id] = dirname
+                else:
+                    apj_board_ids[numeric_board_id] = dirname
+                vid, pid = c.get_USB_IDs()
+                vid_name = c.get_config("USB_STRING_MANUFACTURER", default='"ArduPilot"')
+                pid_name = c.get_config("USB_STRING_PRODUCT", default=dirname)
+                print(f"{numeric_board_id} {dirname} {vid} {vid_name} {pid} {pid_name}")
+
+
+def process_hwdef_file(filepath: str, dirname: str) -> None:
+    vendor_id = None
+    vendor_string = None
+    product_id = None
+    product_string = None
+    apj_board_id_str = None
+    apj_board_id = None
+
+    try:
+        with open(filepath, encoding="utf-8") as file:
+            for line in file:
+                text = line.strip()
+                parts = text.split()
+                if len(parts) >= 2:
+                    if parts[0] == SEARCH_VENDOR_ID:
+                        # Extract vendor ID
+                        vendor_id = int(parts[1], 16)
+                    elif parts[0] == SEARCH_VENDOR_STRING:
+                        # Extract vendor name
+                        vendor_string = parts[1].strip('"').strip("'")
+                    elif parts[0] == SEARCH_PRODUCT_ID:
+                        # Extract product ID
+                        product_id = int(parts[1], 16)
+                    elif parts[0] == SEARCH_PRODUCT_STRING:
+                        # Extract product name
+                        product_string = parts[1].strip('"').strip("'")
+                    elif parts[0] == APJ_BOARD_ID_SEARCH:
+                        # Extract product name
+                        apj_board_id_str = parts[1]
+                    # elif parts[0] == "include":
+                    # return process_hwdef_file(os.path.join(os.path.dirname(filepath), parts[1]), dirname)
+
+    except Exception as e:
+        print(f"Error reading {filepath}: {e}")
+        return
+
+    if apj_board_id_str is None and product_id is None:
+        print(f"Error {filepath} does not contain {APJ_BOARD_ID_SEARCH} nor {SEARCH_PRODUCT_ID}")
+        return
+
+    if apj_board_id_str:
+        try:
+            apj_board_id = int(apj_board_id_str)
+        except ValueError:
+            # use the Tools\AP_Bootloader\board_types.txt contents to convert a APJ_BOARD_ID str to a int
+            apj_board_id = int(board_types[apj_board_id_str])
+        apj_board_ids[apj_board_id] = dirname
+
+    if product_string is None:
+        print(f"{dirname}")
+        product_string = dirname
+
+    # If we successfully found a vendor, manufacturer, and products, add to the result dict
+    if vendor_id is not None and vendor_string is not None:
+        if vendor_id not in result:
+            result[vendor_id] = {"vendor": vendor_string, "PID": {}}
+
+        # Add the product ID and corresponding product string
+        result[vendor_id]["PID"][product_id] = product_string
+
+
+def pretty_print_dict(d: dict, indent: int = 4, format_int_in_hex: bool = True) -> str:
+    """Pretty prints a dictionary, formatting integers in hexadecimal to a string."""
+    output = io.StringIO()
+    for key, value in d.items():
+        # Format the key
+        formatted_key = (
+            f"0x{key:04X}" if isinstance(key, int) and format_int_in_hex else f'"{key}"' if isinstance(key, str) else key
+        )
+        # Format the value
+        if isinstance(value, dict):
+            output.write(" " * indent + f"{formatted_key}: {{\n")
+            output.write(pretty_print_dict(value, indent + 4))  # Recursively pretty print nested dicts
+            output.write(" " * indent + "},\n")
+        elif isinstance(value, int) and format_int_in_hex:
+            formatted_value = f"0x{value:X}"
+            output.write(" " * indent + f"{formatted_key}: {formatted_value},\n")
+        elif isinstance(value, str):
+            output.write(" " * indent + f'{formatted_key}: "{value}",\n')
+        else:
+            output.write(" " * indent + f"{formatted_key}: {value},\n")
+
+    return output.getvalue()  # Return the captured string
+
+
+def write_to_file() -> None:
+    directory = "MethodicConfigurator"
+    os.makedirs(directory, exist_ok=True)  # Create the directory if it doesn't exist
+    file_path = os.path.join(directory, "middleware_fc_ids.py")
+
+    with open(file_path, "w", encoding="utf-8") as file:
+        file.write("# File automatically generated by the update_supported_flight_controllers.py script\n")
+        file.write("# Do not edit directly. ALL CHANGES WILL BE OVERWRITTEN\n")
+        file.write("\n")
+        file.write("from typing import Union\n")
+        file.write("\n")
+        file.write("SUPPORTED_VIDS_AND_PIDS: dict[int, dict[str, Union[str, dict[int, str]]] ] = {\n")
+        file.write(pretty_print_dict(result))  # Use pretty_print_dict to format the output
+        file.write("\n")
+        file.write("}\n")
+        file.write("\n")
+        file.write("APJ_BOARD_IDS: dict[int, str] = {\n")
+        file.write(pretty_print_dict(apj_board_ids, format_int_in_hex=False))  # Use pretty_print_dict to format the output
+        file.write("}\n")
+        file.write("\n")
+        file.write("APJ_BOARD_IDS_BDSHOT: dict[int, str] = {\n")
+        file.write(
+            pretty_print_dict(apj_board_ids_bdshot, format_int_in_hex=False)
+        )  # Use pretty_print_dict to format the output
+        file.write("}\n")
+        file.write("\n")
+
+
+def main() -> None:
+    read_board_types_txt()
+    search_hwdef_files(base_dir)
+    write_to_file()
+
+
+if __name__ == "__main__":
+    main()