import json import os import sys import click from idf_py_actions.errors import FatalError, NoSerialPortFoundError from idf_py_actions.global_options import global_options from idf_py_actions.tools import ensure_build_directory, get_sdkconfig_value, run_target, run_tool PYTHON = sys.executable def action_extensions(base_actions, project_path): def _get_default_serial_port(args): # Import is done here in order to move it after the check_environment() ensured that pyserial has been installed try: import serial.tools.list_ports esptool_path = os.path.join(os.environ['IDF_PATH'], 'components/esptool_py/esptool/') sys.path.insert(0, esptool_path) import esptool ports = list(sorted(p.device for p in serial.tools.list_ports.comports())) # high baud rate could cause the failure of creation of the connection esp = esptool.get_default_connected_device(serial_list=ports, port=None, connect_attempts=4, initial_baud=115200) if esp is None: raise NoSerialPortFoundError( "No serial ports found. Connect a device, or use '-p PORT' option to set a specific port.") serial_port = esp.serial_port esp._port.close() return serial_port except NoSerialPortFoundError: raise except Exception as e: raise FatalError('An exception occurred during detection of the serial port: {}'.format(e)) def _get_esptool_args(args): esptool_path = os.path.join(os.environ['IDF_PATH'], 'components/esptool_py/esptool/esptool.py') esptool_wrapper_path = os.environ.get('ESPTOOL_WRAPPER', '') if args.port is None: args.port = _get_default_serial_port(args) result = [PYTHON] if os.path.exists(esptool_wrapper_path): result += [esptool_wrapper_path] result += [esptool_path] result += ['-p', args.port] result += ['-b', str(args.baud)] with open(os.path.join(args.build_dir, 'flasher_args.json')) as f: flasher_args = json.load(f) extra_esptool_args = flasher_args['extra_esptool_args'] result += ['--before', extra_esptool_args['before']] result += ['--after', extra_esptool_args['after']] result += ['--chip', extra_esptool_args['chip']] if not extra_esptool_args['stub']: result += ['--no-stub'] return result def _get_commandline_options(ctx): """ Return all the command line options up to first action """ # This approach ignores argument parsing done Click result = [] for arg in sys.argv: if arg in ctx.command.commands_with_aliases: break result.append(arg) return result def monitor(action, ctx, args, print_filter, monitor_baud, encrypted, timestamps, timestamp_format): """ Run idf_monitor.py to watch build output """ desc_path = os.path.join(args.build_dir, 'project_description.json') if not os.path.exists(desc_path): ensure_build_directory(args, ctx.info_name) with open(desc_path, 'r') as f: project_desc = json.load(f) elf_file = os.path.join(args.build_dir, project_desc['app_elf']) if not os.path.exists(elf_file): raise FatalError("ELF file '%s' not found. You need to build & flash the project before running 'monitor', " 'and the binary on the device must match the one in the build directory exactly. ' "Try '%s flash monitor'." % (elf_file, ctx.info_name), ctx) idf_monitor = os.path.join(os.environ['IDF_PATH'], 'tools/idf_monitor.py') monitor_args = [PYTHON, idf_monitor] esp_port = args.port or _get_default_serial_port(args) monitor_args += ['-p', esp_port] if not monitor_baud: monitor_baud = os.getenv('IDF_MONITOR_BAUD') or os.getenv('MONITORBAUD') or project_desc['monitor_baud'] monitor_args += ['-b', monitor_baud] monitor_args += ['--toolchain-prefix', project_desc['monitor_toolprefix']] coredump_decode = get_sdkconfig_value(project_desc['config_file'], 'CONFIG_ESP_COREDUMP_DECODE') if coredump_decode is not None: monitor_args += ['--decode-coredumps', coredump_decode] target_arch_riscv = get_sdkconfig_value(project_desc['config_file'], 'CONFIG_IDF_TARGET_ARCH_RISCV') monitor_args += ['--target', project_desc['target']] revision = project_desc.get('rev') if revision: monitor_args += ['--revision', revision] if target_arch_riscv: monitor_args += ['--decode-panic', 'backtrace'] if print_filter is not None: monitor_args += ['--print_filter', print_filter] monitor_args += [elf_file] if encrypted: monitor_args += ['--encrypted'] if timestamps: monitor_args += ['--timestamps'] if timestamp_format: monitor_args += ['--timestamp-format', timestamp_format] idf_py = [PYTHON] + _get_commandline_options(ctx) # commands to re-run idf.py monitor_args += ['-m', ' '.join("'%s'" % a for a in idf_py)] if 'MSYSTEM' in os.environ: monitor_args = ['winpty'] + monitor_args run_tool('idf_monitor', monitor_args, args.project_dir) def flash(action, ctx, args): """ Run esptool to flash the entire project, from an argfile generated by the build system """ ensure_build_directory(args, ctx.info_name) esp_port = args.port or _get_default_serial_port(args) run_target(action, args, {'ESPBAUD': str(args.baud),'ESPPORT': esp_port}) def erase_flash(action, ctx, args): ensure_build_directory(args, ctx.info_name) esptool_args = _get_esptool_args(args) esptool_args += ['erase_flash'] run_tool('esptool.py', esptool_args, args.build_dir) def global_callback(ctx, global_args, tasks): encryption = any([task.name in ('encrypted-flash', 'encrypted-app-flash') for task in tasks]) if encryption: for task in tasks: if task.name == 'monitor': task.action_args['encrypted'] = True break baud_rate = { 'names': ['-b', '--baud'], 'help': 'Baud rate for flashing.', 'scope': 'global', 'envvar': 'ESPBAUD', 'default': 460800, } port = { 'names': ['-p', '--port'], 'help': 'Serial port.', 'scope': 'global', 'envvar': 'ESPPORT', 'default': None, } serial_actions = { 'global_action_callbacks': [global_callback], 'actions': { 'flash': { 'callback': flash, 'help': 'Flash the project.', 'options': global_options + [baud_rate, port], 'order_dependencies': ['all', 'erase_flash'], }, 'erase_flash': { 'callback': erase_flash, 'help': 'Erase entire flash chip.', 'options': [baud_rate, port], }, 'monitor': { 'callback': monitor, 'help': 'Display serial output.', 'options': [ port, { 'names': ['--print-filter', '--print_filter'], 'help': ('Filter monitor output. ' 'Restrictions on what to print can be specified as a series of : items ' 'where is the tag string and is a character from the set ' '{N, E, W, I, D, V, *} referring to a level. ' 'For example, "tag1:W" matches and prints only the outputs written with ' 'ESP_LOGW("tag1", ...) or at lower verbosity level, i.e. ESP_LOGE("tag1", ...). ' 'Not specifying a or using "*" defaults to Verbose level. ' 'Please see the IDF Monitor section of the ESP-IDF documentation ' 'for a more detailed description and further examples.'), 'default': None, }, { 'names': ['--monitor-baud', '-B'], 'type': click.INT, 'help': ('Baud rate for monitor. ' 'If this option is not provided IDF_MONITOR_BAUD and MONITORBAUD ' 'environment variables and project_description.json in build directory ' "(generated by CMake from project's sdkconfig) " 'will be checked for default value.'), }, { 'names': ['--encrypted', '-E'], 'is_flag': True, 'help': ('Enable encrypted flash targets. ' 'IDF Monitor will invoke encrypted-flash and encrypted-app-flash targets ' 'if this option is set. This option is set by default if IDF Monitor was invoked ' 'together with encrypted-flash or encrypted-app-flash target.'), }, { 'names': ['--timestamps'], 'is_flag': True, 'help': 'Print a time stamp in the beginning of each line.', }, { 'names': ['--timestamp-format'], 'help': ('Set the formatting of timestamps compatible with strftime(). ' 'For example, "%Y-%m-%d %H:%M:%S".'), 'default': None } ], 'order_dependencies': [ 'flash', 'encrypted-flash', 'partition_table-flash', 'bootloader-flash', 'app-flash', 'encrypted-app-flash', ], }, 'partition_table-flash': { 'callback': flash, 'help': 'Flash partition table only.', 'options': [baud_rate, port], 'order_dependencies': ['partition_table', 'erase_flash'], }, 'bootloader-flash': { 'callback': flash, 'help': 'Flash bootloader only.', 'options': [baud_rate, port], 'order_dependencies': ['bootloader', 'erase_flash'], }, 'app-flash': { 'callback': flash, 'help': 'Flash the app only.', 'options': [baud_rate, port], 'order_dependencies': ['app', 'erase_flash'], }, 'encrypted-app-flash': { 'callback': flash, 'help': 'Flash the encrypted app only.', 'order_dependencies': ['app', 'erase_flash'], }, 'encrypted-flash': { 'callback': flash, 'help': 'Flash the encrypted project.', 'order_dependencies': ['all', 'erase_flash'], }, }, } return serial_actions