hexianglong/snapclient
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docker Update + macOS flash Instruction (#62)

Browse Source 
* Updated Docker Command for IDF5 + macOS instructions
This commit is contained in:
DerPicknicker
2024-01-24 23:15:52 +01:00
committed by GitHub
Unverified
parent cfd34a8e1f
commit bd17be1b7f
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/docker_build.md
View File

@@ -12,7 +12,7 @@ No need to install ESP-IDF or anything else. All commands should be run in proje
### Start an interactive IDF environnement
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
docker run --rm -it -v .:/project -w /project -v /dev:/dev --privileged espressif/idf:v5.1.1
```
### Configure
@@ -37,12 +37,12 @@ Exit docker interactive shell: `exit`
If you want to execute a specific command or to generate a reusable .bin file.
### menuconfig
```
docker run --rm -it -v .:/project -w /project espressif/idf:v4.3.5 idf.py menuconfig
docker run --rm -it -v .:/project -w /project -v /dev:/dev --privileged espressif/idf:v5.1.1 idf.py menuconfig
```
### Build
```
docker run --rm -it -v .:/project -w /project espressif/idf:v4.3.5 idf.py build
docker run --rm -it -v .:/project -w /project -v /dev:/dev --privileged espressif/idf:v5.1.1 idf.py build
```
### Flash
@@ -50,9 +50,24 @@ Mapping of serial port to container is not simple in windows but you can merge a
- [ESP Tool web flasher](https://espressif.github.io/esptool-js/)
- [ESP32 Flash Download tool](https://www.espressif.com/en/support/download/other-tools)
On MacOS / Linux you need to install a small python package, make sure that pip is installed on your machine:
```
pip install esptool
```
After installation you can start the SerialServer with this command:
```
esp_rfc2217_server.py -v -p 4000 dev/serialDevice
```
Create now a new terminal run the docker container and flash it using this command:
```
idf.py --port 'rfc2217://host.docker.internal:4000?ign_set_control' flash monitor
```
#### Merge bins into single firmware bin file
```
docker run --rm -it -v .:/project -w /project/build espressif/idf:v4.3.1 //runs terminal in idf container
docker run --rm -it -v .:/project -w /project -v /dev:/dev --privileged espressif/idf:v5.1.1 //runs terminal in idf container
esptool.py --chip esp32 merge_bin --output firmware.bin @flash_args // merges all bin files into firmware.bin
```