esp-idf/tools/idf_py_actions
Armando (Dou Yiwen) 17d6768e65 Merge branch 'feature/add_target_esp32p4' into 'master'
esp32p4: introduce the target

See merge request espressif/esp-idf!24155
2023-06-14 10:16:44 +08:00
..
README.md
__init__.py
constants.py esp32p4: introduce the target 2023-06-13 15:16:11 +08:00
core_ext.py tools: fix custom sdkconfig renaming in set-target 2023-03-08 16:45:55 +01:00
create_ext.py
debug_ext.py tools: allow to use hints for debug targets 2023-02-01 15:06:39 +01:00
dfu_ext.py dfu: add esp32s3 to supported DFU targets for idf.py 2022-07-11 15:58:21 +08:00
errors.py
global_options.py
hints.yml tools: Update idf-py hints with Bluedroid HFP AG info 2023-04-06 14:18:27 +08:00
roms.json tools: update esp-rom-elf to version 20230320 2023-03-20 19:20:34 +08:00
roms_schema.json tools: fixed elf symbols load if gdbinit specified 2022-09-21 22:39:03 +04:00
serial_ext.py tools: process progression for flash action output 2023-06-12 13:56:59 +04:00
tools.py tools: process progression for flash action output 2023-06-12 13:56:59 +04:00
uf2_ext.py

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