1
2# Espressif (ESP32 chip series)
3LVGL can be used and configured as a standard [ESP-IDF](https://github.com/espressif/esp-idf) component.
4
5More information about ESP-IDF build system can be found [here](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html).
6
7## LVGL demo project for ESP32
8
9We've created [lv_port_esp32](https://github.com/lvgl/lv_port_esp32), a project using ESP-IDF and LVGL to show one of the demos from [demos](https://github.com/lvgl/lvgl/demos).
10You can configure the project to use one of the many supported display controllers and targets (chips).
11
12See [lvgl_esp32_drivers](https://github.com/lvgl/lvgl_esp32_drivers) repository for a complete list
13of supported display and indev (touch) controllers and targets.
14
15## Using LVGL in your ESP-IDF project
16
17### Prerequisites
18
19 * ESP-IDF v4.1 and above
20 * ESP evaluation board with a display
21
22### Obtaining LVGL
23
24__Option 1:__ git submodule
25
26Simply clone LVGL into your `project_root/components` directory and it will be automatically integrated into the project.
27If the project is a git repository you can include LVGL as a git submodule:
28
29```sh
30git submodule add https://github.com/lvgl/lvgl.git components/lvgl
31```
32
33The above command will clone LVGL's main repository into the `components/lvgl` directory. LVGL includes a `CMakeLists.txt` file that sets some configuration options so you can use LVGL right away.
34
35__Option 2:__ IDF Component Manager
36
37LVGL is also distributed through [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
38It allows users to seamlessly integrate [LVGL component](https://components.espressif.com/component/lvgl/lvgl) into their project with following command:
39
40```sh
41idf.py add-dependency lvgl/lvgl>=8.*
42```
43
44During next project build, LVGL component will be fetched from the component registry and added to project build.
45
46### Configuration
47
48When you are ready to configure LVGL, launch the configuration menu with `idf.py menuconfig` in your project root directory, go to `Component config` and then `LVGL configuration`.
49
50## Using lvgl_esp32_drivers in ESP-IDF project
51
52You can also add `lvgl_esp32_drivers` as a "component". This component should be located inside a directory named "components" in your project root directory.
53
54When your project is a git repository you can include `lvgl_esp32_drivers` as a git submodule:
55
56```sh
57git submodule add https://github.com/lvgl/lvgl_esp32_drivers.git components/lvgl_esp32_drivers
58```
59