lvgl_esp32_drivers/README.md

# Display and touchpad drivers for ESP32 using LVGL

For a ready to use ESP32 project take look at the [lv_port_esp32](https://github.com/lvgl/lv_port_esp32) repository.

#### Table of content
- [Supported display controllers](#supported-display-controllers)
- [Supported indev controllers](#supported-indev-controllers)
- [Support for predefined development kits](#support-for-predefined-development-kits)

**NOTE:** You need to set the display horizontal and vertical size, color depth and
swap of RGB565 color on the LVGL configuration menuconfig (it's not handled automatically).


## Supported display controllers


| Display Controller                          | Type       | Interface              | Color depth (LV_COLOR_DEPTH) | Swap RGB565 color (LV_COLOR_16_SWAP)   |
|---------------------------------------------|------------|------------------------|------------------------------|----------------------------------------|
| ILI9341                                     | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| ILI9163C                                    | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| ILI9486                                     | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| ILI9488                                     | TFT        | SPI                    | 16: RGB565                   | No                                     |
| HX8357B/HX8357D                             | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| ST7789                                      | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| ST7735S                                     | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| FT81x                                       | TFT        | Single, Dual, Quad SPI | 16: RGB565                   | No                                     |
| GC9A01                                      | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| RA8875                                      | TFT        | SPI                    | 16: RGB565                   | Yes                                    |
| SH1107                                      | Monochrome | SPI                    | 1: 1byte per pixel           | No                                     |
| SSD1306                                     | Monochrome | I2C                    | 1: 1byte per pixel           | No                                     |
| IL3820                                      | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
| UC8151D/ GoodDisplay GDEW0154M10 DES        | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
| FitiPower JD79653A/ GoodDisplay GDEW0154M09 | e-Paper    | SPI                    | 1: 1byte per pixel           | No                                     |
| EPDiy supported epaper (needs PCB) | e-Paper    | Parallel               | 4: RGB232 16 grayscales      | No   

Please note that EPDiy supported epapers include also the Lilygo EPD47 that comes with it's own PCB and ESP32 WROVER. Is possible also to build your own EPDiy PCB, please find the [project KiCad source files, schematics, and documentation here](https://github.com/vroland/epdiy/tree/master/hardware/epaper-breakout)
To use an EPDiy supported epaper you need to add it [as a component](https://github.com/martinberlin/lv_port_esp32-epaper/tree/master/components) and also update the CMakeLists of lvgl component to [REQUIRE that library](https://github.com/martinberlin/lv_port_esp32-epaper/wiki).

## Supported indev controllers

- XPT2046
- FT3236
- other FT6X36 or the FT6206 controllers should work as well (not tested)
- STMPE610
- FT81x (Single, Dual, and Quad SPI)

If your display or input device (touch) controller is not supported consider contributing to this repo by
adding support to it! [Contribute controller support](CONTRIBUTE_CONTROLLER_SUPPORT.md)

## Support for predefined development kits

You can also use the predefined kits, which selects the correct display controllers on the kit,
and sets the gpio numbers for the interface.

| Kit name                  | Display controller    | Interface | Hor. Res. | Ver. Res. |
|---------------------------|-----------------------|-----------|-----------|-----------|
| ESP Wrover Kit v4.1       | ILI9341               | SPI       | 240       | 320       |
| M5Stack                   | ILI9341               | SPI       | 240       | 320       |
| M5Core2                   | ILI9341               | SPI       | 240       | 320       |
| M5Stick                   | SH1107                | SPI       | -         | -         |
| M5StickC                  | ST7735S               | SPI       | 80        | 160       |
| Adafruit 3.5 Featherwing  | HX8357                | SPI       | 480       | 320       |
| RPi MPI3501               | ILI9486               | SPI       | -         | -         |
| Wemos Lolin OLED          | SSD1306               | SPI       | 64        | 128       |
| ER-TFT035-6               | ILI9488               | SPI       | 480       | 320       |
| AIRcable ATAGv3           | IL3820                | SPI       | 128       | 296       |
| TTGO T-Display            | ST7789                | SPI       | 135       | 240       |
| TTGO Camera Plus          | ST7789                | SPI       | 240       | 240       |

**NOTE:** See [Supported display controllers](#supported-display-controllers) for more information on display configuration.
**NOTE:** See [Supported indev controllers](#supported-indev-controllers) for more information about indev configuration.
Update README.md 2021-01-09 13:17:15 +00:00			`# Display and touchpad drivers for ESP32 using LVGL`
Update readme 2021-01-05 04:52:33 +00:00
Update README.md 2021-01-09 13:17:15 +00:00			`For a ready to use ESP32 project take look at the [lv_port_esp32](https://github.com/lvgl/lv_port_esp32) repository.`
Update predefined kits 2021-01-06 17:14:00 +00:00
Update README.md 2021-01-09 13:17:15 +00:00			`#### Table of content`
			`- [Supported display controllers](#supported-display-controllers)`
			`- [Supported indev controllers](#supported-indev-controllers)`
			`- [Support for predefined development kits](#support-for-predefined-development-kits)`
Add sections to README 2021-01-06 17:17:06 +00:00
Update README.md 2021-01-09 13:17:15 +00:00			`NOTE: You need to set the display horizontal and vertical size, color depth and`
			`swap of RGB565 color on the LVGL configuration menuconfig (it's not handled automatically).`
Add sections to README 2021-01-06 17:17:06 +00:00

Update README.md 2021-01-09 13:17:15 +00:00			`## Supported display controllers`
Update predefined kits 2021-01-06 17:14:00 +00:00

			`\| Display Controller \| Type \| Interface \| Color depth (LV_COLOR_DEPTH) \| Swap RGB565 color (LV_COLOR_16_SWAP) \|`
			`\|---------------------------------------------\|------------\|------------------------\|------------------------------\|----------------------------------------\|`
			`\| ILI9341 \| TFT \| SPI \| 16: RGB565 \| Yes \|`
Support ILI9163c (Sparkfun LCD-15143) 2021-04-29 07:55:22 +00:00			`\| ILI9163C \| TFT \| SPI \| 16: RGB565 \| Yes \|`
Update predefined kits 2021-01-06 17:14:00 +00:00			`\| ILI9486 \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| ILI9488 \| TFT \| SPI \| 16: RGB565 \| No \|`
			`\| HX8357B/HX8357D \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| ST7789 \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| ST7735S \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| FT81x \| TFT \| Single, Dual, Quad SPI \| 16: RGB565 \| No \|`
			`\| GC9A01 \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| RA8875 \| TFT \| SPI \| 16: RGB565 \| Yes \|`
			`\| SH1107 \| Monochrome \| SPI \| 1: 1byte per pixel \| No \|`
			`\| SSD1306 \| Monochrome \| I2C \| 1: 1byte per pixel \| No \|`
			`\| IL3820 \| e-Paper \| SPI \| 1: 1byte per pixel \| No \|`
			`\| UC8151D/ GoodDisplay GDEW0154M10 DES \| e-Paper \| SPI \| 1: 1byte per pixel \| No \|`
			`\| FitiPower JD79653A/ GoodDisplay GDEW0154M09 \| e-Paper \| SPI \| 1: 1byte per pixel \| No \|`
Update Readme 2021-06-21 18:31:31 +00:00			`\| EPDiy supported epaper (needs PCB) \| e-Paper \| Parallel \| 4: RGB232 16 grayscales \| No`

			`Please note that EPDiy supported epapers include also the Lilygo EPD47 that comes with it's own PCB and ESP32 WROVER. Is possible also to build your own EPDiy PCB, please find the [project KiCad source files, schematics, and documentation here](https://github.com/vroland/epdiy/tree/master/hardware/epaper-breakout)`
			`To use an EPDiy supported epaper you need to add it [as a component](https://github.com/martinberlin/lv_port_esp32-epaper/tree/master/components) and also update the CMakeLists of lvgl component to [REQUIRE that library](https://github.com/martinberlin/lv_port_esp32-epaper/wiki).`
Update readme 2021-01-05 04:52:33 +00:00
Update README.md 2021-01-09 13:17:15 +00:00			`## Supported indev controllers`
Update readme 2021-01-05 04:52:33 +00:00
			`- XPT2046`
			`- FT3236`
			`- other FT6X36 or the FT6206 controllers should work as well (not tested)`
			`- STMPE610`
			`- FT81x (Single, Dual, and Quad SPI)`

			`If your display or input device (touch) controller is not supported consider contributing to this repo by`
			`adding support to it! [Contribute controller support](CONTRIBUTE_CONTROLLER_SUPPORT.md)`

Update README.md 2021-01-09 13:17:15 +00:00			`## Support for predefined development kits`
Update readme 2021-01-05 04:52:33 +00:00
Update predefined kits 2021-01-06 17:14:00 +00:00			`You can also use the predefined kits, which selects the correct display controllers on the kit,`
			`and sets the gpio numbers for the interface.`

			`\| Kit name \| Display controller \| Interface \| Hor. Res. \| Ver. Res. \|`
			`\|---------------------------\|-----------------------\|-----------\|-----------\|-----------\|`
			`\| ESP Wrover Kit v4.1 \| ILI9341 \| SPI \| 240 \| 320 \|`
			`\| M5Stack \| ILI9341 \| SPI \| 240 \| 320 \|`
Added support for M5Core2 screen (CONFIG_LV_PREDEFINED_DISPLAY_M5CORE2) Update README.md 2021-04-28 09:43:40 +00:00			`\| M5Core2 \| ILI9341 \| SPI \| 240 \| 320 \|`
Update predefined kits 2021-01-06 17:14:00 +00:00			`\| M5Stick \| SH1107 \| SPI \| - \| - \|`
			`\| M5StickC \| ST7735S \| SPI \| 80 \| 160 \|`
			`\| Adafruit 3.5 Featherwing \| HX8357 \| SPI \| 480 \| 320 \|`
			`\| RPi MPI3501 \| ILI9486 \| SPI \| - \| - \|`
			`\| Wemos Lolin OLED \| SSD1306 \| SPI \| 64 \| 128 \|`
			`\| ER-TFT035-6 \| ILI9488 \| SPI \| 480 \| 320 \|`
			`\| AIRcable ATAGv3 \| IL3820 \| SPI \| 128 \| 296 \|`
			`\| TTGO T-Display \| ST7789 \| SPI \| 135 \| 240 \|`
			`\| TTGO Camera Plus \| ST7789 \| SPI \| 240 \| 240 \|`
Update readme 2021-01-05 04:52:33 +00:00
Update README.md 2021-01-09 13:17:15 +00:00			`NOTE: See [Supported display controllers](#supported-display-controllers) for more information on display configuration.`
			`NOTE: See [Supported indev controllers](#supported-indev-controllers) for more information about indev configuration.`