|
3 | 3 | * |
4 | 4 | * ## How to Use |
5 | 5 | * |
6 | | - * To use this example, you need to install `esp-display-panel` (includes its dependent libraries) and `LVGL(v8.3.x)` library first, |
| 6 | + * To use this example, please firstly install esp-display-panel and its dependent libraries, |
7 | 7 | * then follow the steps to configure: |
8 | 8 | * |
9 | 9 | * ### Configure esp-display-panel |
10 | 10 | * |
11 | | - * 1. Go to the directory of the installed Arduino libraries. |
12 | | - * 2. Go to the `esp-display-panel` folder, copy `ESP_Panel_Conf_Template.h` and place it out of `esp-display-panel` folder. |
13 | | - * It should be at the same level as the `esp-display-panel` folder. Then rename it as `ESP_Panel_Conf.h`. |
14 | | - * Finally, the layout of the Arduino Libraries folder with `ESP_Panel_Conf.h` should look like this: |
15 | | - * ``` |
16 | | - * Arduino |
17 | | - * |-libraries |
18 | | - * |-esp-display-panel |
19 | | - * |-other_lib_1 |
20 | | - * |-other_lib_2 |
21 | | - * |-ESP_Panel_Conf.h |
22 | | - * ``` |
23 | | - * 3. Open `ESP_Panel_Conf.h` and uncomment one of the following macros to select an supported development board. |
24 | | - * Taking `ESP32_S3_BOX` as an example: |
25 | | - * ```c |
26 | | - * // #define ESP_PANEL_BOARD_ESP32_C3_LCDKIT |
27 | | - * #define ESP_PANEL_BOARD_ESP32_S3_BOX |
28 | | - * // #define ESP_PANEL_BOARD_ESP32_S3_BOX_LITE |
29 | | - * ... |
30 | | - * ``` |
| 11 | + * esp-display-panel has its own configuration file called `ESP_Panel_Conf.h`. After installing esp-display-panel, |
| 12 | + * follow these configuration steps: |
| 13 | + * |
| 14 | + * 1. Navigate to the directory where Arduino libraries are installed. |
| 15 | + * 2. Navigate to the `esp-display-panel` folder, copy `ESP_Panel_Conf_Template.h` and place the copy outside the |
| 16 | + * `esp-display-panel` folder at the same directory level. Then rename the copied file as `ESP_Panel_Conf.h`. |
| 17 | + * 3. Finally, the layout of the Arduino Libraries folder with `ESP_Panel_Conf.h` appear as follows: |
| 18 | + * |
| 19 | + * ``` |
| 20 | + * Arduino |
| 21 | + * |-libraries |
| 22 | + * |-esp-display-panel |
| 23 | + * |-other_lib_1 |
| 24 | + * |-other_lib_2 |
| 25 | + * |-ESP_Panel_Conf.h |
| 26 | + * ``` |
| 27 | + * |
| 28 | + * 4. Please refer to [Supported Boards List](https://github.com/esp-arduino-libs/esp-display-panel#supported-boards--drivers) |
| 29 | + * to check if the current board is compatible. If it is compatible, please navigate to the "For Supported Boards" section; |
| 30 | + * Otherwise, navigate to the "For Unsupported Boards" section. |
| 31 | + * |
| 32 | + * #### For Supported Board |
| 33 | + * |
| 34 | + * 1. Open `ESP_Panel_Conf.h` file. First, set the macro `ESP_PANEL_USE_SUPPORTED_BOARD` to `1` (default is `1`). |
| 35 | + * Then, according to the name of your target development board, uncomment the macro definitions in the format |
| 36 | + * `ESP_PANEL_BOARD_<NAME>` below, |
| 37 | + * 2. The following code takes *ESP32_S3_BOX* development board as an example: |
| 38 | + * |
| 39 | + * ```c |
| 40 | + * ... |
| 41 | + * // #define ESP_PANEL_BOARD_ESP32_C3_LCDKIT |
| 42 | + * #define ESP_PANEL_BOARD_ESP32_S3_BOX |
| 43 | + * // #define ESP_PANEL_BOARD_ESP32_S3_BOX_LITE |
| 44 | + * ... |
| 45 | + * ``` |
| 46 | + * |
| 47 | + * #### For Unsupported Board |
| 48 | + * |
| 49 | + * Please refer to the [document](https://github.com/esp-arduino-libs/esp-display-panel#for-unsupported-board) for the details. |
31 | 50 | * |
32 | 51 | * ### Configure LVGL |
33 | 52 | * |
34 | | - * 1. Go to the directory of the installed Arduino libraries |
35 | | - * 2. Go to the `lvgl` folder, copy `lv_conf_template.h` and place it out of `lvgl` folder. |
36 | | - * It should be at the same level as the `lvgl` folder. Then rename it as `lv_conf.h`. |
37 | | - * Finally, the layout of the Arduino Libraries folder with `lv_conf.h` should look like this: |
38 | | - * ``` |
39 | | - * Arduino |
40 | | - * |-libraries |
41 | | - * |-lv_conf.h |
42 | | - * |-lvgl |
43 | | - * |-other_lib_1 |
44 | | - * |-other_lib_2 |
45 | | - * ``` |
46 | | - * 3. Open `lv_conf.h` and change the first `#if 0` to `#if 1` to enable the content of the file. |
47 | | - * 4. Set the following configurations: |
48 | | - * ```c |
49 | | - * #define LV_COLOR_DEPTH 16 |
50 | | - * #define LV_COLOR_16_SWAP 1 // This configuration is not for RGB LCD. |
51 | | - * // Don't set it if using ESP32-S3-LCD-Ev-Board or ESP32-S3-LCD-Ev-Board-2 |
52 | | - * #define LV_MEM_CUSTOM 1 |
53 | | - * #define LV_MEMCPY_MEMSET_STD 1 |
54 | | - * #define LV_TICK_CUSTOM 1 |
55 | | - * #define LV_FONT_MONTSERRAT_12 1 |
56 | | - * #define LV_FONT_MONTSERRAT_16 1 |
57 | | - * #define LV_USE_DEMO_WIDGETS 1 |
58 | | - * #define LV_USE_DEMO_BENCHMARK 1 |
59 | | - * #define LV_USE_DEMO_STRESS 1 |
60 | | - * #define LV_USE_DEMO_MUSIC 1 |
61 | | - * ``` |
| 53 | + * 1. Navigate to the directory where Arduino libraries are installed. |
| 54 | + * 2. Navigate to the `lvgl` folder, copy `lv_conf_template.h` and place the copy outside the `lvgl` folder at the |
| 55 | + * same directory level. Then rename the copied file as `lv_conf.h`. |
| 56 | + * 3. Finally, the layout of the Arduino Libraries folder with `lv_conf.h` appear as follows: |
| 57 | + * |
| 58 | + * ``` |
| 59 | + * Arduino |
| 60 | + * |-libraries |
| 61 | + * |-lv_conf.h |
| 62 | + * |-lvgl |
| 63 | + * |-other_lib_1 |
| 64 | + * |-other_lib_2 |
| 65 | + * ``` |
| 66 | + * |
| 67 | + * 4. Open `lv_conf.h` and change the first `#if 0` to `#if 1` to enable the content of the file. |
| 68 | + * 5. Set the following configurations: |
| 69 | + * |
| 70 | + * ```c |
| 71 | + * #define LV_COLOR_DEPTH 16 |
| 72 | + * #define LV_COLOR_16_SWAP 1 // This configuration is not for RGB LCD. |
| 73 | + * // Don't set it if using ESP32-S3-LCD-Ev-Board or ESP32-S3-LCD-Ev-Board-2 |
| 74 | + * #define LV_MEM_CUSTOM 1 |
| 75 | + * #define LV_MEMCPY_MEMSET_STD 1 |
| 76 | + * #define LV_TICK_CUSTOM 1 |
| 77 | + * #define LV_FONT_MONTSERRAT_12 1 |
| 78 | + * #define LV_FONT_MONTSERRAT_16 1 |
| 79 | + * #define LV_USE_DEMO_WIDGETS 1 |
| 80 | + * #define LV_USE_DEMO_BENCHMARK 1 |
| 81 | + * #define LV_USE_DEMO_STRESS 1 |
| 82 | + * #define LV_USE_DEMO_MUSIC 1 |
| 83 | + * ``` |
| 84 | + * |
| 85 | + * 6. For more information, please refer to [LVGL document](https://docs.lvgl.io/8.3/get-started/platforms/arduino.html). |
62 | 86 | * |
63 | 87 | * ### Configure Board |
64 | 88 | * |
|
69 | 93 | * | :---------------------: | :----------------: | :------: | :---------: | :---------: | :--------------: | :---------------------: | :---------------: | |
70 | 94 | * | ESP32-C3-LCDkit | ESP32C3 Dev Module | Disabled | QIO | 4MB (32Mb) | Enabled | Default 4MB with spiffs | Info | |
71 | 95 | * | ESP32-S3-Box | ESP32-S3-Box | - | - | - | - | 16M Flash (3MB) | Info | |
| 96 | + * | ESP32-S3-Box-3 | ESP32-S3-Box | - | - | - | - | 16M Flash (3MB) | Info | |
72 | 97 | * | ESP32-S3-Box-Lite | ESP32-S3-Box | - | - | - | - | 16M Flash (3MB) | Info | |
73 | 98 | * | ESP32-S3-EYE | ESP32S3 Dev Module | OPI | QIO 80MHz | 8MB | Enabled | 8M with spiffs | Info | |
74 | 99 | * | ESP32-S3-Korvo-2 | ESP32S3 Dev Module | OPI | QIO 80MHz | 16MB | Disabled | 16M Flash (3MB) | Info | |
|
0 commit comments