mirror of
https://github.com/espressif/esp-idf.git
synced 2026-08-18 06:35:35 +03:00
8c08c75f48
Migrate idf.py and its actions to the shared esp-pylib library: - add esp-pylib (and esp-pylib[ide]) to the core/ide requirements - base FatalError on esp_pylib.errors.FatalError, keeping the idf.py ctx cleanup - replace the local raw-ANSI helpers (red_print/yellow_print/print_warning/ color_print) with esp_pylib.logger.log (warn/err/note/hint) across the idf.py actions - install esp_pylib exception reporting at the idf.py entry point and silence the logger during shell completion - update affected tests for the new prefixes/line wrapping - add normalize_output() helper and unify terminal env in conftest to handle Rich line-wrapping in CI assertions Co-authored-by: Cursor <cursoragent@cursor.com>
89 lines
3.5 KiB
Python
89 lines
3.5 KiB
Python
# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
from esp_pylib.logger import log
|
|
from rich_click import Context
|
|
|
|
from idf_py_actions.errors import FatalError
|
|
from idf_py_actions.tools import PropertyDict
|
|
from idf_py_actions.tools import ensure_build_directory
|
|
from idf_py_actions.tools import get_sdkconfig_filename
|
|
from idf_py_actions.tools import get_sdkconfig_value
|
|
from idf_py_actions.tools import run_target
|
|
|
|
SOC_USB_DFU_SUPPORTED = 'CONFIG_SOC_USB_DFU_SUPPORTED'
|
|
|
|
|
|
def action_extensions(base_actions: dict, project_path: str) -> dict:
|
|
def check_dfu_supported(target_name: str, ctx: Context, args: PropertyDict, **kwargs: str) -> bool:
|
|
sdkconfig_path = get_sdkconfig_filename(args)
|
|
if get_sdkconfig_value(sdkconfig_path, SOC_USB_DFU_SUPPORTED) == 'y':
|
|
return True
|
|
|
|
target = get_sdkconfig_value(sdkconfig_path, 'CONFIG_IDF_TARGET') or 'unknown'
|
|
log.err(f'DFU is not supported for this target: {target}')
|
|
return False
|
|
|
|
def dfu_target(target_name: str, ctx: Context, args: PropertyDict, part_size: str) -> None:
|
|
ensure_build_directory(args, ctx.info_name)
|
|
run_target(target_name, args, {'ESP_DFU_PART_SIZE': part_size} if part_size else {})
|
|
|
|
def dfu_list_target(target_name: str, ctx: Context, args: PropertyDict) -> None:
|
|
ensure_build_directory(args, ctx.info_name)
|
|
run_target(target_name, args)
|
|
|
|
def dfu_flash_target(target_name: str, ctx: Context, args: PropertyDict, path: str) -> None:
|
|
ensure_build_directory(args, ctx.info_name)
|
|
|
|
try:
|
|
run_target(target_name, args, {'ESP_DFU_PATH': path})
|
|
except FatalError:
|
|
# Cannot capture the error from dfu-util here so the best advise is:
|
|
print(
|
|
'Please have a look at the "Device Firmware Upgrade through USB" chapter in API Guides of the '
|
|
'ESP-IDF documentation for solving common dfu-util issues.'
|
|
)
|
|
raise
|
|
|
|
dfu_actions = {
|
|
'actions': {
|
|
'dfu': {
|
|
'callback': dfu_target,
|
|
'check': check_dfu_supported,
|
|
'short_help': 'Build the DFU binary',
|
|
'dependencies': ['all'],
|
|
'options': [
|
|
{
|
|
'names': ['--part-size'],
|
|
'help': 'Large files are split up into smaller partitions in order to avoid timeout during '
|
|
'erasing flash. This option allows to overwrite the default partition size of '
|
|
'mkdfu.py.',
|
|
}
|
|
],
|
|
},
|
|
'dfu-list': {
|
|
'callback': dfu_list_target,
|
|
'check': check_dfu_supported,
|
|
'short_help': 'List DFU capable devices',
|
|
'dependencies': [],
|
|
},
|
|
'dfu-flash': {
|
|
'callback': dfu_flash_target,
|
|
'check': check_dfu_supported,
|
|
'short_help': 'Flash the DFU binary',
|
|
'order_dependencies': ['dfu'],
|
|
'options': [
|
|
{
|
|
'names': ['--path'],
|
|
'default': '',
|
|
'help': 'Specify path to DFU device. The default empty path works if there is just one '
|
|
'ESP device with the same product identifier. See the device list for paths '
|
|
'of available devices.',
|
|
}
|
|
],
|
|
},
|
|
}
|
|
}
|
|
|
|
return dfu_actions
|