feat(esp_mmap_assets): add import path support

Author: espressif2022

components/display/tools/esp_mmap_assets/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ChangeLog
 
+## v1.3.1~1 (2025-05-30)
+
+* Add IMPORT_INC_PATH support.
+
 ## v1.3.1 (2025-03-17)
 
 * Allow appending files to the end of the app_bin.

components/display/tools/esp_mmap_assets/README.md

@@ -54,7 +54,8 @@ set(options
 set(one_value_args
     MMAP_FILE_SUPPORT_FORMAT,
     MMAP_SPLIT_HEIGHT,
-    MMAP_RAW_FILE_FORMAT)
+    MMAP_RAW_FILE_FORMAT
+    IMPORT_INC_PATH)
 ```
 
 ### Option Explanations
@@ -63,6 +64,7 @@ set(one_value_args
 
 - **`FLASH_IN_PROJECT`**: Users can opt to have the image automatically flashed together with the app binaries, partition tables, etc. on `idf.py flash`
 - **`FLASH_APPEND_APP`**: Enables appending binary data (`bin`) to the application binary (`app_bin`).
+- **`IMPORT_INC_PATH`**: Target path for generated include files. Defaults to referencing component location.
 - **`MMAP_FILE_SUPPORT_FORMAT`**: Specifies supported file formats (e.g., `.png`, `.jpg`, `.ttf`).
 - **`MMAP_SPLIT_HEIGHT`**: Defines height for image splitting to reduce memory usage. Depends on:
   - `MMAP_SUPPORT_SJPG`

components/display/tools/esp_mmap_assets/config_template.json.in

@@ -1,6 +1,6 @@
 {
     "project_dir": "@PROJECT_DIR@",
-    "main_path": "@CMAKE_CURRENT_LIST_DIR@",
+    "include_path": "@import_include_path@",
     "assets_path": "@base_dir_full_path@",
     "image_file": "@image_file@",
     "lvgl_ver": "@lvgl_ver@",

components/display/tools/esp_mmap_assets/idf_component.yml

@@ -1,4 +1,4 @@
-version: 1.3.1
+version: 1.3.1~1
 targets:
   - esp32
   - esp32c2

components/display/tools/esp_mmap_assets/project_include.cmake

@@ -18,7 +18,8 @@ function(spiffs_create_partition_assets partition base_dir)
     set(one_value_args MMAP_FILE_SUPPORT_FORMAT
                        MMAP_SPLIT_HEIGHT
                        MMAP_RAW_FILE_FORMAT
-                       MMAP_RAW_COLOR_FORMAT)
+                       MMAP_RAW_COLOR_FORMAT
+                       IMPORT_INC_PATH)
 
     # Define multi-value arguments
     set(multi DEPENDS)
@@ -164,6 +165,13 @@ function(spiffs_create_partition_assets partition base_dir)
             set(arg_MMAP_SPLIT_HEIGHT 0) # Default value
         endif()
 
+        # Handle IMPORT_INC_PATH parameter
+        if(DEFINED arg_IMPORT_INC_PATH)
+            set(import_include_path ${arg_IMPORT_INC_PATH})
+        else()
+            set(import_include_path ${CMAKE_CURRENT_LIST_DIR})
+        endif()
+
         string(TOLOWER "${arg_MMAP_SUPPORT_SJPG}" support_sjpg)
         string(TOLOWER "${arg_MMAP_SUPPORT_SPNG}" support_spng)
         string(TOLOWER "${arg_MMAP_SUPPORT_QOI}" support_qoi)

components/display/tools/esp_mmap_assets/spiffs_assets_gen.py

@@ -41,7 +41,7 @@ class AssetCopyConfig:
 @dataclass
 class PackModelsConfig:
     target_path: str
-    main_path: str
+    include_path: str
     image_file: str
     assets_path: str
     name_length: int
@@ -394,7 +394,7 @@ def pack_assets(config: PackModelsConfig):
     """
 
     target_path = config.target_path
-    assets_c_path = config.main_path
+    assets_include_path = config.include_path
     out_file = config.image_file
     assets_path = config.assets_path
     max_name_len = config.name_length
@@ -460,11 +460,11 @@ def pack_assets(config: PackModelsConfig):
     with open(out_file, 'wb') as output_bin:
         output_bin.write(final_data)
 
-    os.makedirs(assets_c_path, exist_ok=True)
+    os.makedirs(assets_include_path, exist_ok=True)
     current_year = datetime.now().year
 
     asset_name = os.path.basename(assets_path)
-    file_path = os.path.join(assets_c_path, f'mmap_generate_{asset_name}.h')
+    file_path = os.path.join(assets_include_path, f'mmap_generate_{asset_name}.h')
     with open(file_path, 'w') as output_header:
         output_header.write('/*\n')
         output_header.write(' * SPDX-FileCopyrightText: 2022-{} Espressif Systems (Shanghai) CO LTD\n'.format(current_year))
@@ -535,7 +535,7 @@ def process_assets_build(config_data):
     assets_path = config_data['assets_path']
     image_file = config_data['image_file']
     target_path = os.path.dirname(image_file)
-    main_path = config_data['main_path']
+    include_path = config_data['include_path']
     name_length = config_data['name_length']
     split_height = config_data['split_height']
     support_format = [fmt.strip() for fmt in config_data['support_format'].split(',')]
@@ -554,7 +554,7 @@ def process_assets_build(config_data):
 
     pack_config = PackModelsConfig(
         target_path=target_path,
-        main_path=main_path,
+        include_path=include_path,
         image_file=image_file,
         assets_path=assets_path,
         name_length=name_length

components/display/tools/esp_mmap_assets/test_apps/main/CMakeLists.txt

@@ -1,7 +1,8 @@
+set(IMPORT_PATH "${CMAKE_SOURCE_DIR}")
 
 idf_component_register(
     SRC_DIRS "."
-    INCLUDE_DIRS "."
+    INCLUDE_DIRS "." "${IMPORT_PATH}"
 )
 
 set(DIR_SRC         "${PROJECT_DIR}/spiffs_assets")
@@ -26,4 +27,5 @@ spiffs_create_partition_assets(
     FLASH_IN_PROJECT
     FLASH_APPEND_APP
     MMAP_FILE_SUPPORT_FORMAT ".jpg,.png,.ttf"
+    IMPORT_INC_PATH "${IMPORT_PATH}"
 )

components/display/tools/esp_mmap_assets/test_apps/main/mmap_generate_assert_append.h

@@ -1,13 +1,4 @@
 version: 1.0.0
-targets:
-targets:
-  - esp32
-  - esp32c2
-  - esp32c3
-  - esp32c6
-  - esp32h2
-  - esp32s2
-  - esp32s3
 description: I2C driver for AT581x radar sensor
 issues: https://github.com/espressif/esp-iot-solution/issues
 repository: git://github.com/espressif/esp-iot-solution.git