[ESP32] esptool.py not found

[rnicolas]

Hi there!

I'm following this tutorial, but my surprise is when it try to run west flash it gives me this error:

FATAL ERROR: required program C:/Users/user/workspace/zephyrproject/modules/hal/espressif\tools\esptool_py\esptool.py not found; install it or add its location to PATH

Funny thing is west build -b esp32s3_devkitc/esp32s3/procpu samples/hello_world runs well, and it even shows esptool.py v4.7.0. This is the output of the building:

[2/204] Generating ../../../../include/generated/xtensa_handlers_tmp.c
cc1.exe: warning:  is shorter than expected
[6/204] Generating include/generated/zephyr/version.h
-- Zephyr version: 3.7.1 (C:/Users/user/workspace/zephyrproject/zephyr), build: v3.7.1-15-g334900f8d265
[204/204] Linking C executable zephyr\zephyr.elf                                                                                                                                
Memory region         Used Size  Region Size  %age Used
           FLASH:      135484 B    8388352 B      1.62%
     iram0_0_seg:       38544 B       329 KB     11.44%
     dram0_0_seg:       38792 B       313 KB     12.10%
     irom0_0_seg:       14762 B         8 MB      0.18%
     drom0_0_seg:       69948 B         8 MB      0.83%
    rtc_iram_seg:          0 GB         8 KB      0.00%
    rtc_data_seg:          0 GB         8 KB      0.00%
    rtc_slow_seg:          0 GB         8 KB      0.00%
        IDT_LIST:          0 GB         8 KB      0.00%
Generating files from C:/Users/user/workspace/zephyrproject/zephyr/build/zephyr/zephyr.elf for board: esp32s3_devkitc
esptool.py v4.7.0
Creating esp32s3 image...
Image has only RAM segments visible. ROM segments are hidden and SHA256 digest is not appended.
Merged 8 ELF sections
Successfully created esp32s3 image.

So, any idea why west flash is not working as expected?

[rnicolas]

I see west flash is broken, when I run esptool directly

python ../modules/hal/espressif/tools/esptool_py/esptool.py --chip esp32s3 --port COM6 --baud 115200 write_flash 0x10000 build/zephyr/zephyr.bin

I see the board is flashed with this output:

esptool.py v4.7.0
Serial port COM6
Connecting...
Chip is ESP32-S3 (QFN56) (revision v0.2)
Features: WiFi, BLE, Embedded PSRAM 8MB (AP_3v3)
Crystal is 40MHz
MAC: a0:85:e3:e8:00:20
Uploading stub...
Running stub...
Stub running...
Configuring flash size...
Flash will be erased from 0x00010000 to 0x00031fff...
Compressed 135484 bytes to 41335...
Wrote 135484 bytes (41335 compressed) at 0x00010000 in 4.0 seconds (effective 270.9 kbit/s)...
Hash of data verified.

Leaving...
Hard resetting via RTS pin...

But the app crashes:

west espressif monitor                                                                                                           
Serial port COM6
Connecting....
Detecting chip type... ESP32-S3
--- WARNING: GDB cannot open serial ports accessed as COMx
--- Using \\.\COM6 instead...
--- idf_monitor on \\.\COM6 115200 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
ESP-ROM:esp32s3-20210327
Build:Mar 27 2021
rst:0x1 (POWERON),boot:0x8 (SPI_FAST_FLASH_BOOT)
SPIWP:0xee
mode:DIO, clock div:1
load:0x3fce2810,len:0x1120
load:0x403c8700,len:0x4
load:0x403c8704,len:0xb2c
load:0x403cb700,len:0x2d0c
entry 0x403c88a8
abort() was called at PC 0x403cd999
ESP-ROM:esp32s3-20210327
Build:Mar 27 2021
rst:0x10 (RTCWDT_RTC_RST),boot:0x8 (SPI_FAST_FLASH_BOOT)
SPIWP:0xee
mode:DIO, clock div:1
load:0x3fce2810,len:0x1120
load:0x403c8700,len:0x4
load:0x403c8704,len:0xb2c
load:0x403cb700,len:0x2d0c
entry 0x403c88a8
abort() was called at PC 0x403cd999

[rnicolas]

Turns out the build/external/zephyr/scripts/west_commands/runners/esp32.py file is wrong. You can copy & paste this code to make it working:

# Copyright (c) 2017 Linaro Limited.
# Copyright (c) 2021 Espressif Systems (Shanghai) Co., Ltd.
#
# SPDX-License-Identifier: Apache-2.0

'''Runner for flashing ESP32 devices with esptool/espidf.'''

import os
import sys
from os import path

from runners.core import RunnerCaps, ZephyrBinaryRunner


class Esp32BinaryRunner(ZephyrBinaryRunner):
    '''Runner front-end for espidf.'''

    def __init__(self, cfg, device, boot_address, part_table_address,
                 app_address, erase=False, reset=False, baud=921600,
                 flash_size='detect', flash_freq='40m', flash_mode='dio',
                 espidf='espidf', bootloader_bin=None, partition_table_bin=None,
                 encrypt=False, no_stub=False):
        super().__init__(cfg)
        self.elf = cfg.elf_file
        self.app_bin = cfg.bin_file
        self.erase = bool(erase)
        self.reset = bool(reset)
        self.device = device
        self.boot_address = boot_address
        self.part_table_address = part_table_address
        self.app_address = app_address
        self.baud = baud
        self.flash_size = flash_size
        self.flash_freq = flash_freq
        self.flash_mode = flash_mode
        self.espidf = espidf
        self.bootloader_bin = bootloader_bin
        self.partition_table_bin = partition_table_bin
        self.encrypt = encrypt
        self.no_stub = no_stub

    @classmethod
    def name(cls):
        return 'esp32'

    @classmethod
    def capabilities(cls):
        return RunnerCaps(commands={'flash'}, erase=True, reset=True)

    @classmethod
    def do_add_parser(cls, parser):
        # Required
        parser.add_argument('--esp-idf-path', required=True,
                            help='path to ESP-IDF')
        # Optional
        parser.add_argument('--esp-boot-address', default='0x1000',
                            help='bootloader load address')
        parser.add_argument('--esp-partition-table-address', default='0x8000',
                            help='partition table load address')
        parser.add_argument('--esp-app-address', default='0x10000',
                            help='application load address')
        parser.add_argument('--esp-device', default=os.environ.get('ESPTOOL_PORT', None),
                            help='serial port to flash')
        parser.add_argument('--esp-baud-rate', default='921600',
                            help='serial baud rate, default 921600')
        parser.add_argument('--esp-monitor-baud', default='115200',
                            help='serial monitor baud rate, default 115200')
        parser.add_argument('--esp-flash-size', default='detect',
                            help='flash size, default "detect"')
        parser.add_argument('--esp-flash-freq', default='40m',
                            help='flash frequency, default "40m"')
        parser.add_argument('--esp-flash-mode', default='dio',
                            help='flash mode, default "dio"')
        parser.add_argument(
            '--esp-tool',
            help='''if given, complete path to espidf. default is to search for
            it in [ESP_IDF_PATH]/tools/esptool_py/esptool.py''')
        parser.add_argument('--esp-flash-bootloader',
                            help='Bootloader image to flash')
        parser.add_argument('--esp-flash-partition_table',
                            help='Partition table to flash')
        parser.add_argument('--esp-encrypt', default=False, action='store_true',
                            help='Encrypt firmware while flashing (correct efuses required)')
        parser.add_argument('--esp-no-stub', default=False, action='store_true',
                            help='Disable launching the flasher stub, only talk to ROM bootloader')

        parser.set_defaults(reset=True)

    @classmethod
    def do_create(cls, cfg, args):
        if args.esp_tool:
            espidf = args.esp_tool
        else:
            espidf = os.path.normpath(path.join(args.esp_idf_path, 'tools', 'esptool_py', 'esptool.py')).replace('\\', '/')

        return Esp32BinaryRunner(
            cfg, args.esp_device, boot_address=args.esp_boot_address,
            part_table_address=args.esp_partition_table_address,
            app_address=args.esp_app_address, erase=args.erase, reset=args.reset,
            baud=args.esp_baud_rate, flash_size=args.esp_flash_size,
            flash_freq=args.esp_flash_freq, flash_mode=args.esp_flash_mode,
            espidf=espidf, bootloader_bin=args.esp_flash_bootloader,
            partition_table_bin=args.esp_flash_partition_table,
            encrypt=args.esp_encrypt, no_stub=args.esp_no_stub)

    def do_run(self, command, **kwargs):
        if not os.path.exists(self.espidf):
            self.logger.error(f"Expected esptool.py at: {self.espidf}")
            raise RuntimeError("Cannot continue without esptool.py")


        # Add Python interpreter
        cmd_flash = [sys.executable, self.espidf, '--chip', 'auto']

        if self.device is not None:
            cmd_flash.extend(['--port', self.device])

        if self.erase is True:
            cmd_erase = cmd_flash + ['erase_flash']
            self.check_call(cmd_erase)

        if self.no_stub is True:
            cmd_flash.extend(['--no-stub'])
        cmd_flash.extend(['--baud', self.baud])
        cmd_flash.extend(['--before', 'default_reset'])
        if self.reset:
            cmd_flash.extend(['--after', 'hard_reset', 'write_flash', '-u'])
        cmd_flash.extend(['--flash_mode', self.flash_mode])
        cmd_flash.extend(['--flash_freq', self.flash_freq])
        cmd_flash.extend(['--flash_size', self.flash_size])

        if self.encrypt:
            cmd_flash.extend(['--encrypt'])

        if self.bootloader_bin:
            cmd_flash.extend([self.boot_address, self.bootloader_bin])
            if self.partition_table_bin:
                cmd_flash.extend([self.part_table_address, self.partition_table_bin])
                cmd_flash.extend([self.app_address, self.app_bin])
        else:
            cmd_flash.extend([self.app_address, self.app_bin])

        self.logger.info(f"Flashing esp32 chip on {self.device} ({self.baud}bps)")
        self.check_call(cmd_flash)

[rftafas]

Actually, it is not that it is wrong, because it works on Linux. It indeed has the slash problems on Windows (and Zephyr until very recently didn't support windows). I see you fixed this, so I suggest forwarding this contribution.

[edit] it is already there: #88605

[klushund]

Works for me, but the path of esp32.py is different: zephyrproject/zephyr/scripts/west_commands/runners/esp32.py