- Linux platform
- Docker
- Repository clone (refer to README.md)
No need to install ESP-IDF or anything else. All commands should be run in project root folder.
In this interactive shell you can run menuconfig, build, flash and monitor command.
docker run --rm -it -v .:/project -w /project -v /dev:/dev --privileged espressif/idf:v4.3.5
Then in your docker interactive shell, start by configuring for your platform. More info about the config in README.md.
idf.py menuconfig
Save with <s>
and exit with <q>
.
idf.py build flash monitor
If idf.py can't access to USB devices, try to restart your docker interactive shell in sudo.
Exit IDF monitor mode: <Ctrl+]>
Exit docker interactive shell: exit
If you want to execute a specific command or to generate a reusable .bin file.
docker run --rm -it -v .:/project -w /project espressif/idf:v4.3.5 idf.py menuconfig
docker run --rm -it -v .:/project -w /project espressif/idf:v4.3.5 idf.py build
Mapping of serial port to container is not simple in windows but you can merge all generated bin
files into single firmware and flash the firmware manually using some windows tool.
docker run --rm -it -v .:/project -w /project/build espressif/idf:v4.3.1 //runs terminal in idf container
esptool.py --chip esp32 merge_bin --output firmware.bin @flash_args // merges all bin files into firmware.bin
Write build/firmware.bin
to ESP32 at address 0x0000
docker run
--rm // Removes container after exit
-it // runs interactive terminal
-v .:/project // maps current directory to /project in container
-w /project // sets working directory inside a container to /project
-v /dev:/dev // maps devices directory to acces USB and Serial devices inside docker
--privileged // grants docker rights to acces host devices
espressif/idf:v4.3.5 // image name + version
idf.py menuconfig // run menuconfig