esp-idf/tools/idf_py_actions
Ivan Grokhotkov bac77b4bf7 Merge branch 'feature/idf-list-ports' into 'master'
idf.py: Use function for port detection from esptool.py in idf.py and idf_monitor.py

Closes IDFGH-3104

See merge request espressif/esp-idf!11359
2021-01-08 21:36:08 +08: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: merge C3 changes into master 2020-12-30 07:04:12 +08:00
core_ext.py add new command to idf 2020-09-21 23:38:52 +02:00
create_ext.py add new command to idf 2020-09-21 23:38:52 +02:00
debug_ext.py idf.py: Fixed gdb target to exit cleanly when no openocd watch task 2020-09-18 08:30:21 +02:00
dfu_ext.py Add ability to select a device for DFU flashing 2020-05-28 09:31:35 +02:00
errors.py idf.py: debug targets for easier execution of openocd, gdb, gdbui 2020-04-07 17:37:48 +02:00
global_options.py Add idf.py extensions and move core actions to separate files 2019-10-30 10:34:17 +01:00
README.md Fix typo and naming format for extensions 2019-10-30 10:34:17 +01:00
serial_ext.py Imporove port detection in idf.py 2020-12-31 14:25:52 +01:00
tools.py idf.py: Disable CMake --warn-uninitialized option by default 2020-08-26 09:53:56 +10:00
uf2_ext.py tools: Wrap flash binaries into a UF2 file for flashing through USB MSC 2020-12-29 18:14:47 +01:00

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