Historia

Ivan Grokhotkov 25041ba583 tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.		2020-02-13 18:46:26 +01:00
..
README.md	Fix typo and naming format for extensions	2019-10-30 10:34:17 +01:00
__init__.py	…
constants.py	global: rename esp32s2beta to esp32s2	2020-01-22 12:14:38 +08:00
core_ext.py	idf.py: use underlying flash targets	2020-01-15 03:36:47 +00:00
errors.py	Use component manager if available as python package	2019-12-19 16:48:36 +01:00
global_options.py	…
serial_ext.py	tools/idf_monitor: automatically decode UART core dumps	2020-02-13 18:46:26 +01:00
tools.py	Merge branch 'fix/tools_py_environ_str' into 'master'	2020-02-10 14:28:35 +08:00

README.md

idf.py extensions

Python modules (subdirectories and files) in this directory named [your_extension]_ext will be loaded as idf.py extensions. If you want to provide extra extensions just provide ; separated list of directories with extensions in IDF_EXTRA_ACTIONS_PATH. Extensions will be loaded in alphanumeric order. Command line arguments parsing and extension mechanism is implemented on top of Click (versions >=5.0 are supported).

They should define a function action_extensions(base_actions, project_path) where:

base_actions - dictionary with actions that are already available for idf.py
project_path - working dir, may be defaulted to os.getcwd()

This function have to return a dict with 3 possible keys:

{
    # Additional options that will be available from id
    "global_options": [{
        "names": ["--option-name"],
        "help": "Help for option --option-name.",
    }],
    # List of functions that will have access to full app context, and can mangle with arguments
    "global_action_callbacks": [global_callback],
    # Additional subcommands for idf.py
    "actions": {
        "subcommand_name": {
            "callback": subcommand_callback,
            "help": "Help for subcommand.",
        },
    },
}

Where function global_callback(ctx, global_args, tasks) accepts 3 arguments:

ctx - Click context
global_args - dictionary of all available global arguments
tasks - list of Task objects

And subcommand_callback(subcommand_name, ctx, args) accepts 3 arguments:

subcommand_name - name of subcommand
ctx - Click context
args - list of command's arguments