LVGL project for ESP32

This is an ESP32 demo project showcasing LVGL v7 with support for several display controllers and touch controllers. The demo application is the demo_widgets project from the lv_examples repository.

Version of LVGL used: 7.0. Version of lv_examples used: 7.0.

Monochrome support:

Supported display controllers

NOTE: You now need to set the Color depth and Swap the 2 bytes of RGB565 color on the LVGL configuration menuconfig (it's no longer handled automatically).

This will allow to add more color depths when the display controller supports them.

Display Controller	Type	Interface	Color depth (LV_COLOR_DEPTH)	Swap the 2 bytes of RGB565 color (LV_COLOR_16_SWAP)
ILI9341	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

Supported touchscreen 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 controller is not supported consider contributing to this repo by adding support to it! Contribute controller support

Get started

Install the ESP32 SDK

http://esp-idf.readthedocs.io/en/latest/

Note:

This project tries to be compatible with both the ESP-IDF v3.x and v4.0, but using the v4.0 is recommended. Instructions here are given for the v4.x toolchain using idf.py, but it is easy to translate to make. For example instead of running idf.py menuconfig, just run make menuconfig.

When using the ESP-IDF v3.x framework you must use make to build the project!.

Build this repository standalone and run the demo.

Try this first to make sure your hardware is supported, wired and configured properly.

Get this project: git clone --recurse-submodules https://github.com/lvgl/lv_port_esp32.git
From its root run idf.py menuconfig
Select your display kit or board and other options - see config options
For monochrome displays we suggest enabling the unscii 8 font (Component config -> LVGL configuration -> FONT USAGE) and the MONO theme (Component config -> LVGL configuration -> THEME USAGE).
Store your project configuration.
For monochrome displays edit the lv_conf.h file available on the components/lvgl directory to look like follows:

#define LV_THEME_DEFAULT_INIT               lv_theme_mono_init
#define LV_THEME_DEFAULT_COLOR_PRIMARY      LV_COLOR_BLACK
#define LV_THEME_DEFAULT_COLOR_SECONDARY    LV_COLOR_WHITE
#define LV_THEME_DEFAULT_FLAG               0
#define LV_THEME_DEFAULT_FONT_SMALL         &lv_font_unscii_8
#define LV_THEME_DEFAULT_FONT_NORMAL        &lv_font_unscii_8
#define LV_THEME_DEFAULT_FONT_SUBTITLE      &lv_font_unscii_8
#define LV_THEME_DEFAULT_FONT_TITLE         &lv_font_unscii_8

idf.py build
idf.py -p (YOUR PORT) flash (with make this is just make flash - in 3.x PORT is configured in menuconfig)

Support for development kits with embedded TFT displays.

Several ESP32 evaluation kits are supported via preconfigurations.

ESP Wrover Kit v4.1
M5Stack
M5Stick
M5StickC
Adafruit 3.5 Featherwing
RPi MPI3501
Wemos Lolin OLED
ER-TFT035-6
AIRcable ATAGv3

Install this project as a library submodule in your own project

It is recommended to install this repo as a submodule in your IDF project's git repo. The configuration system has been designed so that you do not need to copy or edit any files in this repo. By keeping your submodule directory clean you can ensure reproducible builds and easy updates from this upstream repository.

From your project root (you can get the esp32 idf project template here):

mkdir -p components
git submodule add https://github.com/lvgl/lv_port_esp32.git components/lv_port_esp32
git submodule update --init --recursive
Edit your CMake or Makefile to add this repo's components folder to the IDF components path.

CMake

The examples below are taken from the ESP-IDF blink example which you can copy and use as the basis for your own project. The project root CMakeLists.txt file needs one line added, just before the project to add the extra components directory to the path like this:

#CMakeLists.txt
cmake_minimum_required(VERSION 3.5)

include($ENV{IDF_PATH}/tools/cmake/project.cmake)

set(EXTRA_COMPONENT_DIRS components/lv_port_esp32/components/lv_examples components/lv_port_esp32/components/lvgl components/lv_port_esp32/components/lvgl_esp32_drivers/lvgl_tft components/lv_port_esp32/components/lvgl_esp32_drivers/lvgl_touch components/lv_port_esp32/components/lvgl_esp32_drivers)

project(blink)

In the CMakeLists.txt file for your /main or for the component(s) using LVGL you need to add REQUIRES directives for this project's driver and lvgl itself to the idf_component_register function, it should look like this:

set (SOURCES main.c)

idf_component_register(SRCS ${SOURCES}
    INCLUDE_DIRS .
    REQUIRES lvgl_esp32_drivers lvgl lv_examples lvgl_tft lvgl_touch)

target_compile_definitions(${COMPONENT_LIB} PRIVATE LV_CONF_INCLUDE_SIMPLE=1)

Please note that if your project require the use of the nvs_flash module (for example required by WiFi), it should be put in the REQUIRES list.

Makefile

If you are using make, you only need to add the EXTRA_COMPONENT_DIRS in the root Makefile of your project:

PROJECT_NAME := blink

EXTRA_COMPONENT_DIRS := components/lv_port_esp32/components/lv_examples \
    components/lv_port_esp32/components/lvgl \
    components/lv_port_esp32/components/lvgl_esp32_drivers/lvgl_tft \
    components/lv_port_esp32/components/lvgl_esp32_drivers/lvgl_touch \
    components/lv_port_esp32/components/lvgl_esp32_drivers \

include $(IDF_PATH)/make/project.mk

Configuration options

There are a number of configuration options available, all accessed through idf.py menuconfig -> Components -> LittlevGL (LVGL).

You can configure the TFT controller and the touch controller (if your display have one)

Touch Controller options

Options include:

Touch controller options

Pinout

SPI Bus: Choose what SPI bus is used to communicate with the touch controller.

Touchpanel configuration: Maximum and minimum coordinate values, inverting coordinate values, etc.

TFT Controller options

Options include:

Display controller: Support for the most common TFT display controllers

SPI Bus: Choose what SPI bus is used to communicate with the tft controller.

Display resolution - set the height and width of the display

Invert display - if text and objects are backwards, you can enable this
Enable backlight control via GPIO (vs hardwiring on)
Backlight active high or low - some displays expect a high (1) signal to enable backlight, others expect (low) (default) - if your backlight doesn't come on try switching this

Assign the correct pinout depending on your ESP32 dev board

There are several development boards based on the ESP32 chip, make sure you assign the correct pin numbers to the signals that interface with the TFT display board. Its recommended to use a predefined configuration below, but you can also set individual pins for both display controller and touch controller.

Predefined Display Configurations

For development kits that come with a display already attached, all the correct settings are already known and can be selected in menuconfig from the first option "Select predefined display configuration." Once selected all the other options will be defaulted and won't appear in the menu.

Platformio support

Using the lv_platformio project add the following lines to platformio.ini file:

[env:esp32]
platform = espressif32
framework = espidf
board = esp-wrover-kit

Change the default environment to default_envs = esp32.

Modify the main.c like this:

#include "lvgl.h"

// #include "driver.h"

#include "demo.h"

int app_main(void)
{
    lv_init();

    /* Initialize your hardware. */
    
    /* hw_init(); */

    demo_create();

    /* Create the UI or start a task for it.
     * In the end, don't forget to call `lv_task_handler` in a loop. */

    /* hw_loop(); */

    return 0;

For more information see: platformio with espidf framework compability.

cmumford / lv_port_esp32