Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hpsaturn/esp32s3-linux

ESP32 S3 Linux - Docker builder
https://github.com/hpsaturn/esp32s3-linux

Last synced: 14 days ago
JSON representation

ESP32 S3 Linux - Docker builder

Awesome Lists containing this project

README 

        

# ESP32 S3 Linux - Docker builder



The initial version was a Dockerfile ported by Adafruit from the work of [@jcmvbkbc](http://wiki.osll.ru/doku.php/etc:users:jcmvbkbc:linux-xtensa:esp32s3). The current version uses the last version of the build scripts like a git submodule and it has some improvements on the DockerFile to support USB flashing.



	

		

			Don't forget to star ⭐ this repository

		

	



## Build



Please follow the next steps:



1. Download or clone this repo



```bash

git clone --recursive https://github.com/hpsaturn/esp32s3-linux.git && cd esp32s3-linux

```



2. Then build the docker image:



```bash

docker build --build-arg DOCKER_USER=$USER --build-arg DOCKER_USERID=$UID -t esp32linuxbase .

```



3. Copy settings sample:



```bash

cp settings.cfg.default settings.cfg

```



(**Note**: For the first build and install, leave the same settings than the default, without parameters)



4. Run the build script of your preference, for example:



```bash

docker run --rm -it --name esp32s3linux --user="$(id -u):$(id -g)" -v ./esp32-linux-build:/app --env-file settings.cfg --device=/dev/ttyACM0 esp32linuxbase ./rebuild-esp32s3-linux-wifi.sh

```



Keep in mind that you should change the **--device** to your USB device where is connected the ESP32S3. For a different script please check the directory `esp32-linux-build`. This step takes around ~35 minutes and needs ~20Gb.



After that you should have this message:



![ESP32S3 Linux finish build](screenshots/docker_build_before_flash.jpg)



## Flashing



1. Open a different terminal and enter to the running container:



```bash

docker exec -it -u root esp32s3linux bash

```



2. Change the docker USB device permissions:



```bash

chmod 666 /dev/ttyACM0 

```



3. Return to the main terminal and perform the flashing. **And that's it!**



![ESP32S3 Linux final flashing](screenshots/docker_flashing.jpg)



Please check the output, you should have the flashed of **/etc** partition at the end (only that in the first install), with a final message like this:



```bash

Written contents of file 'build-buildroot-esp32s3/images/etc.jffs2' at offset 0xb0000

```



---



# Linux boot



For run it in a TTGO T7 S3 (LilyGO board), you should have a FTDI connection to the UART like is showed in the photos below. Some dev boards have a second USB-C for this, then you could omit that.



![ESP32 S3 TTGO T7](https://user-images.githubusercontent.com/423856/249864617-08cf71ac-8773-4c3b-b5a3-d8912b5b9c05.jpg)  



For the complete details of features and current restrictions, please review the official [wiki](http://wiki.osll.ru/doku.php/etc:users:jcmvbkbc:linux-xtensa:esp32s3).



## WiFi settings



Only add your credentials on `/etc/wpa_supplicant.conf` using `vi` editor or from the command line, like this:



```bash

cat > /etc/wpa_supplicant.conf < /etc/cmdline

```



### Provisional GPIO handling



```bash

devmem 0x60004020 32 2 # (output enable for gpio1)

devmem 0x60004004 32 2 # (drive gpio1 high)

```



For other GPIO be careful the syntax and the addressing, for instance for the LilyGO TTGO T7S3 board and its LED, the GPIO is the IO17, then you should be pass the number in hexadecimal, like this:



```bash

devmem 0x60004020 32 0x20000 # (ouput enable for GPIO 17)

devmem 0x60004004 32 0x20000 # (set GPIO 17 high)

```



Also you can enable the LED on the startup in a simple `inet.d` service:



![GPIO working via devmem](screenshots/gpio_via_devmem.jpg)



Complete guide of GPIO implementation [here](http://wiki.osll.ru/doku.php/etc:users:jcmvbkbc:linux-xtensa:esp32s3:gpio)  

More info in the [technical document](https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf) of the ESP32S3.



# Updates



After the first build and flashing, you can keep the sources and working directories changing the `settings.cfg` file and repeating the steps from the step 4. Also don't forget update before, the git submodules like this:



```bash

git submodule update --init --recursive

```



## Possible settings



Put `y` to enable some one or nothing to disable, like this:



```bash

# keep_toolchain=y	-- don't rebuild the toolchain, but rebuild everything else

# keep_rootfs=y		-- don't reconfigure or rebuild rootfs from scratch. Would still apply overlay changes

# keep_buildroot=y	-- don't redownload the buildroot, only git pull any updates into it

# keep_bootloader=y	-- don't redownload the bootloader, only rebuild it

# keep_etc=y		-- don't overwrite the /etc partition

```



For fast re-builds, fast updates and also keep your **etc** and its config files, for instance configure it like this:



```bash

keep_toolchain=y

keep_rootfs=y

keep_buildroot=y

keep_bootloader=y

keep_etc=y

```



## Clean



For clean the working directories, please enter to `esp32-linux-build` and remove the build directory and rebuild with the settings with empty parameters.



# TODO



- [x] Migrate to the last script version with build parameters

- [x] Freezing repositories to specific commit

- [x] Add provisioning stuff (etc partition)

- [ ] Improve the flashing step. Fix issue #10



# Credits



Main script and initial idea: [@jcmvbkbc](https://gist.github.com/jcmvbkbc/316e6da728021c8ff670a24e674a35e6)  

[Official Wiki](http://wiki.osll.ru/doku.php/etc:users:jcmvbkbc:linux-xtensa:esp32s3)  

English/Spanish [ESP32 Telegram group](https://t.me/esp_es)