idf-ext

Powershell module extending capabilities of ESP-IDF framework and simplifying work with it

@PowershellGallery

In powershell:

Install-Module -Name idf-ext

A wrapper around idf.py. You can use it freely instead of idf.py

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Dot-sourcing export.ps1. If the path is not containing export.ps1, checks the upper level. If reaches the top (e.g. C:\) checks $env:IDF_PATH.

Typical usecase:

  C:\Users\dongr\Desktop\blink
> Idf-Export
 - Checking : C:\Users\dongr\Desktop
 - Checking : C:\Users\dongr
 - Checking : C:\Users
 - Checking : C:\
 - Checking : $env:IDF_PATH
 - Found IDF!
...
...
...
Done! You can now compile ESP-IDF projects.
Go to the project directory and run:
    idf.py build


[ DONE ] Success:
True

  C:\Users\dongr\Desktop\blink
>

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Runs install.ps1 using search logic like at Idf-Export

Typical usecase:

  C:\Users\dongr\Desktop\blink
> Idf-Install
 - Checking : C:\Users\dongr\Desktop
 - Checking : C:\Users\dongr
 - Checking : C:\Users
 - Checking : C:\
 - Checking : $env:IDF_PATH
 - Found IDF!
Installing ESP-IDF tools
...
...
...
All done! You can now run:
    export.ps1

[ DONE ] Success:
True

  C:\Users\dongr\Desktop\blink
>

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Return the project name parsing CMakeLists.txt

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Return the project's target parsing sdkconfig

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Removes ./build directory, sdkconfig, sdkconfig.old

Place all IDF variable to your system environment (to the user scope) permanently. Instead of adding to PATH creates IDF_BIN_PATHS that you can append manually

Uses idf_tools.py export to generate the list of variables

Arguments:

• Path - path to export. Non-mandatory. If not set the current working directory is used

Prints a summary information:

IDF info
    - IDF_PATH          C:\Users\dongr\.espressif\esp-idf
    - IDF_TOOLS_PATH    C:\Users\dongr\.espressif
Project info
    - Name                blink
    - Target              Not set. Use "idf set-target TARGET_NAME"

This work is licensed under the terms of the MIT license.

For a copy, see: LICENSE

• site: https://agramakov.me
• e-mail: mail@agramakov.me