Awesome Open Source
Awesome Open Source

idfx ⚡️

While there is no support for USB devices on WSL2 for now, this tool comes to help you to flash and monitor ESP-IDF and ESP8266_SDK applications on the WSL2.

Info:
Tested on Ubuntu 20.04 LTS and Debian distributions.

Note:
As a prerequisite for using this tool, Python 🐍 needs to be installed on the Windows.

Supported ESP-IDF versions

idfx supports:

Installation

Execute next command inside of your WSL to install idfx

wget https://git.io/JyBgj -O $HOME/.local/bin/idfx && chmod u+x $HOME/.local/bin/idfx

Usage

Signature:

idfx COMMAND [PORT]

Where the PORT is serial COM Port on the Windows (use the Device Manager to find your port).

For the full usage please execute next command:

idfx help

Examples

For most of the cases (when you edit the code of your application) you can use idfx all COM2 because this command will build, flash and monitor your app, at once. Of course, you need to change COM2 (in previous command) with correct COM port.

Command Description
idfx all COM2 Build project, flash and monitor serial output, using port COM2
idfx build Build project
idfx flash COM2 Flashing project using port COM2
idfx monitor COM2 Display serial output of port COM2
idfx flash COM2 monitor Flash project and display serial output, using port COM2
idfx erase-flash COM2 Erase the entire flash, using port COM2
idfx help Show the idfx usage

How to install ESP-IDF on WSL2

On this link you can find complete tutorial about how to setup ESP-IDF under WSL2 and how to use idfx to build, flash and monitor your ESP application.

Preview

idfx preview

Author

abobija - abobija.com

License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Shell (228,911
Linux (16,994
Windows (10,063
Bash (7,135
Ubuntu (3,401
Esp8266 (2,930
Esp32 (2,743
Debian (1,994
Monitor (1,079
Usb (847
Flash (435
Esp Idf (410
Support (317
Wsl2 (159
Com Port (17
Related Projects