Add espressif esp-idf-size to the build engine to show firmware metrics (#179)

Author: Jason2866

.github/workflows/examples.yml

@@ -20,10 +20,10 @@ jobs:
           - "examples/arduino-wifiscan"
           - "examples/arduino-zigbee-light"
           - "examples/arduino-zigbee-switch"
+          - "examples/arduino-NimBLE-ext_client"
+          - "examples/arduino-matter-light"
           - "examples/tasmota"
-          - "examples/espidf-arduino-h2zero-BLE_scan"
           - "examples/espidf-arduino-matter-light"
-          - "examples/arduino-matter-light"
           - "examples/espidf-arduino-blink"
           - "examples/espidf-arduino-littlefs"
           - "examples/espidf-blink"

boards/m5stack-atoms3u.json

@@ -0,0 +1,42 @@
+{
+  "build": {
+    "arduino": {
+      "memory_type": "qio_opi",
+      "partitions": "default_8MB.csv"
+    },
+    "core": "esp32",
+    "extra_flags": [
+      "-DARDUINO_M5Stack_ATOMS3U",
+      "-DARDUINO_USB_MODE=1",
+      "-DARDUINO_USB_CDC_ON_BOOT=1",
+      "-DARDUINO_RUNNING_CORE=1",
+      "-DARDUINO_EVENT_RUNNING_CORE=1"
+    ],
+    "f_cpu": "240000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "dio",
+    "mcu": "esp32s3",
+    "variant": "m5stack_atoms3"
+  },
+  "connectivity": [
+    "bluetooth",
+    "wifi"
+  ],
+  "debug": {
+    "openocd_target": "esp32s3.cfg"
+  },
+  "frameworks": [
+    "arduino",
+    "espidf"
+  ],
+  "name": "M5Stack AtomS3U",
+  "upload": {
+    "flash_size": "8MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 8388608,
+    "require_upload_port": true,
+    "speed": 460800
+  },
+  "url": "https://docs.m5stack.com/en/core/AtomS3U",
+  "vendor": "M5Stack"
+}

builder/frameworks/arduino.py

@@ -103,7 +103,8 @@ def _get_installed_pip_packages():
         "wheel": ">=0.35.1",
         "rich-click": ">=1.8.6",
         "PyYAML": ">=6.0.2",
-        "intelhex": ">=2.3.0"
+        "intelhex": ">=2.3.0",
+        "esp-idf-size": ">=1.6.1"
     }
 
     installed_packages = _get_installed_pip_packages()

builder/frameworks/espidf.py

@@ -56,6 +56,11 @@
 env = DefaultEnvironment()
 env.SConscript("_embed_files.py", exports="env")
 
+# remove maybe existing old map file in project root
+map_file = os.path.join(env.subst("$PROJECT_DIR"), env.subst("$PROGNAME") + ".map")
+if os.path.exists(map_file):
+    os.remove(map_file)
+
 def install_standard_python_deps():
     def _get_installed_standard_pip_packages():
         result = {}
@@ -83,7 +88,8 @@ def _get_installed_standard_pip_packages():
     deps = {
         "wheel": ">=0.35.1",
         "rich-click": ">=1.8.6",
-        "PyYAML": ">=6.0.2"
+        "PyYAML": ">=6.0.2",
+        "esp-idf-size": ">=1.6.1"
     }
 
     installed_packages = _get_installed_standard_pip_packages()
@@ -147,13 +153,6 @@ def _get_installed_standard_pip_packages():
 assert os.path.isdir(FRAMEWORK_DIR)
 assert os.path.isdir(TOOLCHAIN_DIR)
 
-if (
-    ["espidf"] == env.get("PIOFRAMEWORK")
-    and semantic_version.Version.coerce(__version__)
-    <= semantic_version.Version("6.1.10")
-    and "__debug" in COMMAND_LINE_TARGETS
-):
-    print("Warning! Debugging an IDF project requires PlatformIO Core >= 6.1.11!")
 
 if "arduino" in env.subst("$PIOFRAMEWORK"):
     ARDUINO_FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoespressif32")
@@ -401,7 +400,6 @@ def get_project_lib_includes(env):
 
     return paths
 
-
 def is_cmake_reconfigure_required(cmake_api_reply_dir):
     cmake_cache_file = os.path.join(BUILD_DIR, "CMakeCache.txt")
     cmake_txt_files = [
@@ -1791,18 +1789,30 @@ def get_python_exe():
         LIBSOURCE_DIRS=[os.path.join(ARDUINO_FRAMEWORK_DIR, "libraries")]
     )
 
+extra_cmake_args = [
+    "-DIDF_TARGET=" + idf_variant,
+    "-DPYTHON_DEPS_CHECKED=1",
+    "-DEXTRA_COMPONENT_DIRS:PATH=" + ";".join(extra_components),
+    "-DPYTHON=" + get_python_exe(),
+    "-DSDKCONFIG=" + SDKCONFIG_PATH,
+]
+
+if "CPPDEFINES" in env:
+    flatten_cppdefines = env.Flatten(env['CPPDEFINES'])
+    if "SHOW_METRICS" in flatten_cppdefines:
+        # This will add the linker flag for the map file
+        extra_cmake_args.append(
+            f'-DCMAKE_EXE_LINKER_FLAGS=-Wl,-Map={os.path.join(BUILD_DIR, env.subst("$PROGNAME") + ".map")}'
+        )
+
+# Add any extra args from board config
+extra_cmake_args += click.parser.split_arg_string(board.get("build.cmake_extra_args", ""))
+
 print("Reading CMake configuration...")
 project_codemodel = get_cmake_code_model(
     PROJECT_DIR,
     BUILD_DIR,
-    [
-        "-DIDF_TARGET=" + idf_variant,
-        "-DPYTHON_DEPS_CHECKED=1",
-        "-DEXTRA_COMPONENT_DIRS:PATH=" + ";".join(extra_components),
-        "-DPYTHON=" + get_python_exe(),
-        "-DSDKCONFIG=" + SDKCONFIG_PATH,
-    ]
-    + click.parser.split_arg_string(board.get("build.cmake_extra_args", "")),
+    extra_cmake_args
 )
 
 # At this point the sdkconfig file should be generated by the underlying build system

builder/main.py

@@ -21,6 +21,9 @@
     DefaultEnvironment)
 
 from platformio.util import get_serial_ports
+from platformio.project.helpers import get_project_dir
+
+import os
 
 env = DefaultEnvironment()
 platform = env.PioPlatform()
@@ -68,12 +71,10 @@ def _normalize_frequency(frequency):
     frequency = str(frequency).replace("L", "")
     return str(int(int(frequency) / 1000000)) + "m"
 
-
 def _get_board_f_flash(env):
     frequency = env.subst("$BOARD_F_FLASH")
     return _normalize_frequency(frequency)
 
-
 def _get_board_f_image(env):
     board_config = env.BoardConfig()
     if "build.f_image" in board_config:
@@ -88,7 +89,6 @@ def _get_board_f_boot(env):
 
     return _get_board_f_flash(env)
 
-
 def _get_board_flash_mode(env):
     if _get_board_memory_type(env) in (
         "opi_opi",
@@ -101,15 +101,13 @@ def _get_board_flash_mode(env):
         return "dio"
     return mode
 
-
 def _get_board_boot_mode(env):
     memory_type = env.BoardConfig().get("build.arduino.memory_type", "")
     build_boot = env.BoardConfig().get("build.boot", "$BOARD_FLASH_MODE")
     if memory_type in ("opi_opi", "opi_qspi"):
         build_boot = "opi"
     return build_boot
 
-
 def _parse_size(value):
     if isinstance(value, int):
         return value
@@ -122,7 +120,6 @@ def _parse_size(value):
         return int(value[:-1]) * base
     return value
 
-
 def _parse_partitions(env):
     partitions_csv = env.subst("$PARTITIONS_TABLE_CSV")
     if not isfile(partitions_csv):
@@ -163,7 +160,6 @@ def _parse_partitions(env):
     env["INTEGRATION_EXTRA_DATA"].update({"application_offset": str(hex(app_offset))})
     return result
 
-
 def _update_max_upload_size(env):
     if not env.get("PARTITIONS_TABLE_CSV"):
         return
@@ -192,17 +188,13 @@ def _update_max_upload_size(env):
             board.update("upload.maximum_size", _parse_size(p["size"]))
             break
 
-
-
 def _to_unix_slashes(path):
     return path.replace("\\", "/")
 
-
 #
 # Filesystem helpers
 #
 
-
 def fetch_fs_size(env):
     fs = None
     for p in _parse_partitions(env):
@@ -226,12 +218,10 @@ def fetch_fs_size(env):
         env["FS_START"] += 4096
         env["FS_SIZE"] -= 4096
 
-
 def __fetch_fs_size(target, source, env):
     fetch_fs_size(env)
     return (target, source)
 
-
 board = env.BoardConfig()
 mcu = board.get("build.mcu", "esp32")
 toolchain_arch = "xtensa-%s" % mcu
@@ -367,6 +357,24 @@ def check_lib_archive_exists():
 if not env.get("PIOFRAMEWORK"):
     env.SConscript("frameworks/_bare.py", exports="env")
 
+
+def firmware_metrics(target, source, env):
+    map_file = os.path.join(env.subst("$BUILD_DIR"), env.subst("$PROGNAME") + ".map")
+    if not os.path.isfile(map_file):
+        # map file can be in project dir
+        map_file = os.path.join(get_project_dir(), env.subst("$PROGNAME") + ".map")
+
+    if os.path.isfile(map_file):
+        try:
+            import subprocess
+            # Show output of esp_idf_size, but suppresses the command echo
+            subprocess.run([
+                env.subst("$PYTHONEXE"), "-m", "esp_idf_size", "--ng", map_file
+            ], check=False)
+        except Exception:
+            print("Warning: Failed to run firmware metrics. Is esp-idf-size installed?")
+            pass
+
 #
 # Target: Build executable and linkable firmware or FS image
 #
@@ -381,6 +389,9 @@ def check_lib_archive_exists():
         target_firm = join("$BUILD_DIR", "${PROGNAME}.bin")
 else:
     target_elf = env.BuildProgram()
+    silent_action = env.Action(firmware_metrics)
+    silent_action.strfunction = lambda target, source, env: '' # hack to silence scons command output
+    env.AddPostAction(target_elf, silent_action)
     if set(["buildfs", "uploadfs", "uploadfsota"]) & set(COMMAND_LINE_TARGETS):
         target_firm = env.DataToBin(
             join("$BUILD_DIR", "${ESP32_FS_IMAGE_NAME}"), "$PROJECT_DATA_DIR"
@@ -565,6 +576,7 @@ def check_lib_archive_exists():
 else:
     sys.stderr.write("Warning! Unknown upload protocol %s\n" % upload_protocol)
 
+
 env.AddPlatformTarget("upload", target_firm, upload_actions, "Upload")
 env.AddPlatformTarget("uploadfs", target_firm, upload_actions, "Upload Filesystem Image")
 env.AddPlatformTarget(

examples/arduino-NimBLE-ext_client/README.md

@@ -0,0 +1,5 @@
+# NimBLE_extended_client example using h2zero Arduino NimBLE stack
+
+BLE 5 client example, using the great [h2zero NimBLE](https://github.com/h2zero/NimBLE-Arduino) implementation.
+
+Thx @h2zero for the great BLE library.

examples/espidf-arduino-h2zero-BLE_scan/include/README renamed to examples/arduino-NimBLE-ext_client/include/README

@@ -0,0 +1,53 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env]
+platform = espressif32
+framework = arduino
+monitor_speed = 115200
+build_flags =
+    '-DCONFIG_BT_NIMBLE_EXT_ADV=1'
+lib_deps =
+    https://github.com/h2zero/NimBLE-Arduino
+lib_ignore =
+    BLE
+    BluetoothSerial
+    SimpleBLE
+    WiFiProv
+custom_component_remove =
+    espressif/esp_hosted
+    espressif/esp_wifi_remote
+    espressif/esp-dsp
+    espressif/network_provisioning
+    espressif/esp_rainmaker
+    espressif/rmaker_common
+    espressif/esp_insights
+    espressif/esp_diag_data_store
+    espressif/esp_diagnostics
+    espressif/libsodium
+    espressif/esp-modbus
+    espressif/esp-cbor
+    espressif/esp-sr
+    espressif/esp32-camera
+
+[env:esp32s3]
+board = esp32-s3-devkitc-1
+
+[env:esp32c2]
+board = esp32-c2-devkitm-1
+
+[env:esp32c3]
+board = esp32-c3-devkitm-1
+
+[env:esp32c6]
+board = esp32-c6-devkitm-1
+
+[env:esp32h2]
+board = esp32-h2-devkitm-1