https://github.com/pibsas/micropython_lilygo_tdisplay_s3_smartconfig

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/pibsas/micropython_lilygo_tdisplay_s3_smartconfig
Owner: PIBSAS
License: mit
Created: 2024-12-14T15:55:21.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2026-04-01T16:11:41.000Z (3 months ago)
Last Synced: 2026-04-01T22:54:23.143Z (3 months ago)
Language: Python
Size: 12.5 MB
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# MicroPython + S3LCD para LilyGo T-Display S3 ESP32-S3-WROOM-1-N16R8

## Datasheet:

- [ESP-S3-WROOM-1/1U](https://www.espressif.com/sites/default/files/documentation/esp32-s3-wroom-1_wroom-1u_datasheet_en.pdf)

## Docs:
- [ESP-S3 User Guide DevKitC v1.1](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html)

![LilyGO T-Display S3](T-DISPLAY-S3.jpg)

## ESP-IDF:
- [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/stable/esp32s3/get-started/linux-macos-setup.html)

## MicroPython
- [MicroPython](https://github.com/micropython/micropython/blob/master/ports/esp32/README.md)

# MicroPython LilyGO T-Display S3 + S3LCD Driver

# Probado en -- Tested on Ubuntu WSL 2024:

- ```bash
wsl --install Ubuntu
```
![Wsl](media/Wsl.png)

### Una vez instalado Ubuntu -- Once Installed Ubuntu:

#### Actualizar e instalar requerimientos -- Update and Install Requirements:

- ```bash
sudo apt update && sudo apt upgrade -y
```
![Update](media/Update.png)

- ```bash
sudo apt install -y build-essential git wget flex bison gperf pkg-config python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
```
![Dependencias](media/Dependencies.png)

### Clonar ésta repo -- Clone this repo, MicroPython y ESP-IDF compatible con MicroPython(En la actualidad "Micropython 1.24" 5.04 a 5.2.2):

- ```bash
git clone https://github.com/PIBSAS/MicroPython_LilyGO_T_Display_S3.git
```
![Clone Repo](media/Clone_Repo.png)

- ```bash
git clone https://github.com/micropython/micropython.git
```
![Clone Micropython](media/Clone_Micropython.png)

### ESP-IDF v5.0.4:
- ```bash
mkdir esp
cd esp
git clone -b v5.0.4 --recursive https://github.com/espressif/esp-idf.git
```
![Clone ESP-IDF](media/Clone_ESP-IDF.png)

### ESP-IDF v5.2:
- ```bash
mkdir esp
cd esp
git clone -b v5.2 --recursive https://github.com/espressif/esp-idf.git
```

### ESP-IDF v5.2.2:
- ```bash
mkdir esp
cd esp
git clone -b v5.2.2 --recursive https://github.com/espressif/esp-idf.git
```

### Instalar CMake mediante -- Install CMake with ``idf_tools.py``:

- ```bash
cd esp-idf/tools
```

- ```bash
python3 idf_tools.py install cmake
```
![CMAKE Install](media/CMAKE_Install.png)

### Regresar un directorio y ejecutar el script para ESP32S3 -- Back a directory and execute the Script for ESP32S3:

- ```bash
cd ..
./install.sh esp32s3
```
![Install](media/Install.png)

### Ejecutar -- Run:
- ```bash
. ./export.sh
```
![Export Script](media/Export.png)

### Copiar el directorio ``ESP32_GENERIC_S3_N16R8`` y su contenido al directorio boards -- Copy recursively ``ESP32_GENERIC_S3_N16R8`` folder and his content to boards folder:

- ```bash
cd
cp -r ESP32-S3-WROOM-1-N16R8/ESP32_GENERIC_S3_N16R8 micropython/ports/esp32/boards
```
![Copy](media/Copy_Repo.png)

### Dirigirnos al directorio MicroPython y ejecutar mpy-cross -- Go to MicroPython folder and run mpy-cross:

- ```bash
cd
cd micropython/
make -C mpy-cross
```
![Make Mpy](media/Make.png)

### Indicar el ``IDF_TARGET`` -- Indicate ``IDF_TARGET``:

- ```bash
export IDF_TARGET=esp32s3
```
![IDF-Target](media/IDF_Target.png)

### Movernos a -- Move to ```ports/esp32```:

- ```bash
cd ports/esp32/
```

### Compilar MicroPython para ESP32 S3 -- Compile MicroPython for ESP32 S3:

- ```bash
make BOARD=ESP32_GENERIC_S3_N16R8 submodules
```
- ```bash
make BOARD=ESP32_GENERIC_S3_N16R8
```
![Makes](media/Makes.png)

#### Al final con ESP-IDF v5.0.4 nos indica -- At the end show us with ESP-IDF v5.0.4:

- Project build complete. To flash, run this command:
- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p (PORT) -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```
![Success-Changed to new name folder](media/Success.png)

#### Or run 'idf.py -p (PORT) flash':

| bootloader | @0x000000 | 18672 ( 14096 remaining) |
|-------------|-------------|-------------------------------|
| partitions | @0x008000 | 3072 ( 1024 remaining) |
| application | @0x010000 | 1396208 ( 635408 remaining) |
| total | | 1461744 |

- Se debe cambiar ``(PORT)`` por ``COM29`` por ejemplo o en linux ``/dev/ttyACM0``

#### Al final con ESP-IDF v5.2 nos indica -- At the end show us with ESP-IDF v5.2:

- Project build complete. To flash, run this command:
- ```bash
python -m esptool --chip esp32s3 -b 460800 --before default_reset --after no_reset write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```
![Success](media/Success_ESP-IDFv5.2.png)

#### Al final con ESP-IDF v5.2.2 nos indica -- At the end show us with ESP-IDF v5.2.2:

## ESP-IDF v5.0.4:
### Borramos la flash -- Erase flash:
- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p /dev/ttyACM0 erase_flash
```
![Erase Flash](media/Erase.png)

### Luego flasheamos -- Then flash:
- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p COM29 -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```
![Flash](media/Flash.png)

## ESP-IDF v5.2:

- ```bash
python -m esptool --chip esp32s3 -b 460800 --before default_reset --after no_reset write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```

## ESP-IDF v5.2.2:

# WSL:

## Instalar -- Install USBIPD:

- ```bash
winget install --interactive --exact dorssel.usbipd-win
```

### Abrir Terminal(Administrador) conectar el ESP32 y escribir -- Open Terminasl(Admin) plug ESP32 and type:

- ```bash
usbipd list
```
- Observar el -- See ``BUSID`` del -- of esp ``(USB-Enhanced-SERIAL CH343 (COM29)``. Ej: ``2-1``

### Escribir -- Type:

- ```bash
usbipd bind --busid 2-1
```

- ```bash
usbipd attach --wsl --busid 2-1
```

### En WSL Ubuntu(Distro) agregar el usuario al grupo ``dialout`` -- On WSL Ubuntu add user to ``dialout`` group:

- ```bash
sudo adduser $USER dialout
```

### En Terminal(Administrador) Comprobar que figure ``Attached`` en la columna ``STATE`` con -- On Teminal(Admin) Verify ``Attached`` on ``STATE`` column with:

- ```bash
usbipd list
```
## ESP-IDF v5.0.4:
### Luego en WSL borramos la flash -- Then on WSL erase the flash:

- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p /dev/ttyACM0 erase_flash
```

### Luego flasheamos -- Then flash:
- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p /dev/ttyACM0 -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```

## ESP-IDF v5.2:
- ```bash
python -m esptool --chip esp32s3 -b 460800 --before default_reset --after no_reset write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```

## ESP-IDF v5.2.2:
- ```bash
python -m esptool --chip esp32s3 -b 460800 --before default_reset --after no_reset write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```

#### After flash detach the board with usbipd so is available for Windows:
- ```bash
usbipd detach --busid 2-1
```

# Linux:

- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p /dev/ttyACM0 erase_flash
```
- ```bash
$HOME/.espressif/python_env/idf5.0_py3.10_env/bin/python ../../../esp/esp-idf/components/esptool_py/esptool/esptool.py -p /dev/ttyACM0 -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build-ESP32_GENERIC_S3_N16R8/bootloader/bootloader.bin 0x8000 build-ESP32_GENERIC_S3_N16R8/partition_table/partition-table.bin 0x10000 build-ESP32_GENERIC_S3_N16R8/micropython.bin
```

## Reference

- [micropython/micropython/issues/8635](https://github.com/micropython/micropython/issues/8635#issuecomment-1129218506)

# The Lazy way:
- Just Download the bin Firmware files.

> :warning: Files need to be where is esptool or type full path of files ⚠️

## Install ESPtool:
- ```bash
pip install esptool
```

### Replace (PORT)"Doesn't need port", with yours Linux: /dev/ttyACM0 Windows: COM12 (After com goes the number detected on your pc)

### Erase flash:
- Linux(On Ubuntu python3 instead just python): ````python -m esptool erase_flash````
- Windows: ````python -m esptool erase_flash````
- Windows with Virtual Environment: ````esptool erase_flash````

### Flash:
- ```bash
python -m esptool -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 micropython.bin
```

#### Windows with Virtual Environment:
- ```bash
esptool -b 460800 --before default_reset --after no_reset --chip esp32s3 write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 micropython.bin
```

> :warning: For pip on newest OSes you need to make virtual environment:

### Windows:
- ```bash
python -m venv esp-env
```
or
- ```bash
py -m venv esp-env
.\esp-env\Scripts\activate
Once activated install esptool:
- (esp-env)PS C:....> ```pip install esptool```

### NOTE IN WINDOWS:
- If you get a PowerShell Scripts Policy Execution Exception that don't let you activate the Virtual Environment:

````bash
.\esp-env\Scripts\activate
````

- Then open a Terminal like Administrator and type:

````bash
Set-ExecutionPolicy Unrestricted
````
- Close the Terminal now you can activate the Python Virtual Environment.

---

### Linux:
- ```bash
python .m venv esp-env
source esp-env/bin/activate
```
Once activated install esptool:
- (esp-env) ...$: ```pip install esptool```

### ESP Tool Docs:
- [ESP Tool Documentation](https://docs.espressif.com/projects/esptool/en/latest/esp32s3/esptool/index.html#esptool)

### If you want add Libraries to your build, then copy them to ``micropython/ports/esp32/modules/`` folder all ``*.py`` you want, look the space left, becarefull.

# Smartconfig Apps from:
- [ESP-Touch for Android](https://www.espressif.com/en/support/download/apps)
- [ESP-Touch for iOS](https://www.espressif.com/en/support/download/apps)
- Smartconfig example in [examples](examples/smart.py) folder in this repo.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pibsas/micropython_lilygo_tdisplay_s3_smartconfig

Awesome Lists containing this project

README