esp_idf_size_map_file_memory_usage_summary.py

1import os
2from esp_idf_size import MapFileReader
3
4# Path to the .map file generated by the ESP-IDF build system
5# Usually found in the 'build' directory of your project
6map_file_path = os.path.join('build', 'my_project.map')
7
8def main():
9    # Check if the map file exists
10    if not os.path.exists(map_file_path):
11        print(f"Error: {map_file_path} not found. Please build your project first.")
12        return
13
14    # Initialize the MapFileReader
15    # This parses the GNU Linker map file into a Python object
16    reader = MapFileReader(map_file_path)
17
18    # Get the detailed memory usage information
19    # This includes DRAM, IRAM, Flash, and other segments
20    summary = reader.get_size_info()
21
22    # Print a simple summary of the binary size
23    print("ESP-IDF Memory Usage Summary:")
24    print("-" * 30)
25    for segment, info in summary.items():
26        # Each segment contains 'size', 'used', and 'unused' attributes
27        print(f"{segment:<15}: {info['used']:>8} bytes used")
28
29if __name__ == "__main__":
30    main()