acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
espressif.md (2659B)
      1 ```eval_rst
      2 .. include:: /header.rst
      3 :github_url: |github_link_base|/get-started/platforms/espressif.md
      4 ```
      5 
      6 # Espressif (ESP32 chip series)
      7 LVGL can be used and configured as a standard [ESP-IDF](https://github.com/espressif/esp-idf) component.
      8 
      9 More 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).
     10 
     11 ## LVGL demo project for ESP32
     12 
     13 We'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).
     14 You can configure the project to use one of the many supported display controllers and targets (chips).
     15 
     16 See [lvgl_esp32_drivers](https://github.com/lvgl/lvgl_esp32_drivers) repository for a complete list
     17 of supported display and indev (touch) controllers and targets.
     18 
     19 ## Using LVGL in your ESP-IDF project
     20 
     21 ### Prerequisites
     22 
     23  * ESP-IDF v4.1 and above
     24  * ESP evaluation board with a display
     25 
     26 ### Obtaining LVGL
     27 
     28 __Option 1:__ git submodule
     29 
     30 Simply clone LVGL into your `project_root/components` directory and it will be automatically integrated into the project.
     31 If the project is a git repository you can include LVGL as a git submodule:
     32 
     33 ```sh
     34 git submodule add https://github.com/lvgl/lvgl.git components/lvgl
     35 ```
     36 
     37 The 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.
     38 
     39 __Option 2:__ IDF Component Manager
     40 
     41 LVGL is also distributed through [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
     42 It allows users to seamlessly integrate [LVGL component](https://components.espressif.com/component/lvgl/lvgl) into their project with following command:
     43 
     44 ```sh
     45 idf.py add-dependency lvgl/lvgl>=8.*
     46 ```
     47 
     48 During next project build, LVGL component will be fetched from the component registry and added to project build.
     49 
     50 ### Configuration
     51 
     52 When 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`.
     53 
     54 ## Using lvgl_esp32_drivers in ESP-IDF project
     55 
     56 You can also add `lvgl_esp32_drivers` as a "component". This component should be located inside a directory named "components" in your project root directory.
     57 
     58 When your project is a git repository you can include `lvgl_esp32_drivers` as a git submodule:
     59 
     60 ```sh
     61 git submodule add https://github.com/lvgl/lvgl_esp32_drivers.git components/lvgl_esp32_drivers
     62 ```