Historia

Marius Vikhammer fbbcf5c5bc dfu: add esp32s3 to supported DFU targets for idf.py		2022-07-21 15:58:44 +08:00
..
README.md	Fix typo and naming format for extensions	2019-10-30 10:34:17 +01:00
__init__.py	Add idf.py extensions and move core actions to separate files	2019-10-30 10:34:17 +01:00
constants.py	tools: Add docs subcommand docs which opens browser with documentation for current version of idf and model of your target	2021-07-12 10:56:37 +02:00
core_ext.py	feat(idf.py): add `idf.py clang-check` and `idf.py clang-html-report`	2022-05-24 16:08:40 +08:00
create_ext.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
debug_ext.py	tools: replace _ with - in idf.py	2021-10-13 17:30:38 +08:00
dfu_ext.py	dfu: add esp32s3 to supported DFU targets for idf.py	2022-07-21 15:58:44 +08:00
errors.py	Fixed automatic connection in idf_monitor	2021-02-11 17:35:46 +01:00
global_options.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
serial_ext.py	tools: set baudrate and port with otatool.	2022-03-11 15:30:56 +01:00
tools.py	Tools: make idf_size work with overflow	2021-09-16 14:12:46 +02:00
uf2_ext.py	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +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