idf-web-ide

cloud/ desktop IDE for ESP-IDF based on Eclipse Theia

APACHE-2.0 License

Stars
16
Committers
2

Espressif IDF WEB IDE

Cloud or desktop IDE for ESP-IDF quick development with Espressif devices that includes the ESP-IDF extension for Visual Studio Code.

Made with Eclipse Theia.

Getting started

Run as Docker Container (suggested)

  • Pull the latest or an existing version from Docker Hub:

    docker pull espbignacio/idf-web-ide

  • Create and Start a container from that image, notice we are mounting host OS ${PWD} to /home/projects of the container

    $ docker run -d -e IWI_PORT=8080 -p 8080:8080 --platform linux/amd64 -v ${PWD}:/home/projects espbignacio/idf-web-ide

  • Open http://0.0.0.0:8080 in your browser (use chrome for best experience)

Run Directly from Source

  • $ git clone https://github.com/espressif/idf-web-ide.git

  • $ cd idf-web-ide

  • Run $ yarn (nodejs, yarn is required for this step)

  • $ cd browser-app

  • $ yarn run start --port=8080

  • Open 127.0.0.1:8080 in your browser (use chrome for best experience)

  • Alternatively, build the Docker Image using the DockerFile in the source

    $ docker build . --tag espbignacio/idf-web-ide --platform linux/amd64

  • Run the image as container as shown in the previous section.

Use the desktop companion to flash and monitor local Espressif devices

Using the Espressif IDF Web Desktop Companion you can remotely flash and monitor an Espressif device from this IDF Web IDE.

You can get a built executable from Windows here.

  • .\dist\main.exe --port PORT with the executable to start the desktop companion and .\dist\main.exe to see available ports.

From source code run:

  • pip3 install -r ${ESP-IWIDC}/requirements.txt to install the python requirements.
  • python3 main.py to see available serial ports.
  • python3 main.py --port [SERIAL_PORT_OF_ESP_32] to start desktop companion.