mirror of
https://github.com/espressif/esp-idf.git
synced 2024-09-21 06:56:11 -04:00
c043c43247
We take the GC9A01 as an example to illustrate how to implement user's own panel driver in their project folder, without making the esp-idf dirty.
83 lines
5.0 KiB
Markdown
83 lines
5.0 KiB
Markdown
# GC9A01 porting example
|
|
|
|
[esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/lcd.html) provides several panel drivers out-of box, e.g. ST7789, SSD1306, NT35510. However, there're a lot of other panels on the market, it's beyond `esp_lcd` component's responsibility to include them all.
|
|
|
|
`esp_lcd` allows user to add their own panel drivers in the project scope (i.e. panel driver can live outside of esp-idf), so that the upper layer code like LVGL porting code can be reused without any modifications, as long as user-implemented panel driver follows the interface defined in the `esp_lcd` component.
|
|
|
|
This example shows how to add the GC9A01 driver in the project folder but still use the API provided by `esp_lcd` component. As GC9A01 is famous in the form of a circular screen, this example will draw a fancy dash board with the LVGL library. For more information about porting the LVGL library, you can also refer to another [lvgl porting example](../lvgl/README.md).
|
|
|
|
## How to use the example
|
|
|
|
### Hardware Required
|
|
|
|
* An ESP development board
|
|
* An GC9A01 LCD panel, with SPI interface
|
|
* An USB cable for power supply and programming
|
|
|
|
### Hardware Connection
|
|
|
|
The connection between ESP Board and the LCD is as follows:
|
|
|
|
```
|
|
ESP Board GC9A01 Panel
|
|
┌──────────────────────┐ ┌────────────────────┐
|
|
│ GND ├─────────────►│ GND │
|
|
│ │ │ │
|
|
│ 3V3 ├─────────────►│ VCC │
|
|
│ │ │ │
|
|
│ PCLK ├─────────────►│ SCL │
|
|
│ │ │ │
|
|
│ DATA0 ├─────────────►│ SDA │
|
|
│ │ │ │
|
|
│ RST ├─────────────►│ RES │
|
|
│ │ │ │
|
|
│ DC ├─────────────►│ DC │
|
|
│ │ │ │
|
|
│ CS ├─────────────►│ CS │
|
|
│ │ │ │
|
|
│ BK_LIGHT ├─────────────►│ BLK │
|
|
└──────────────────────┘ └────────────────────┘
|
|
```
|
|
|
|
The GPIO number used by this example can be changed in [lvgl_example_main.c](main/lvgl_example_main.c).
|
|
Especially, please pay attention to the level used to turn on the LCD backlight, some LCD module needs a low level to turn it on, while others take a high level. You can change the backlight level macro `EXAMPLE_LCD_BK_LIGHT_ON_LEVEL` in [lvgl_example_main.c](main/lvgl_example_main.c).
|
|
|
|
### Build and Flash
|
|
|
|
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A fancy animation will show up on the LCD as expected.
|
|
|
|
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
|
|
|
(To exit the serial monitor, type ``Ctrl-]``.)
|
|
|
|
See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.
|
|
|
|
### Example Output
|
|
|
|
```bash
|
|
...
|
|
I (304) cpu_start: Starting scheduler.
|
|
I (308) example: Turn off LCD backlight
|
|
I (308) gpio: GPIO[2]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0
|
|
I (318) example: Initialize SPI bus
|
|
I (318) example: Install panel IO
|
|
I (328) gpio: GPIO[5]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0
|
|
I (338) example: Install GC9A01 panel driver
|
|
I (338) gpio: GPIO[3]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0
|
|
I (468) example: Turn on LCD backlight
|
|
I (468) example: Initialize LVGL library
|
|
I (468) example: Register display driver to LVGL
|
|
I (468) example: Install LVGL tick timer
|
|
I (468) example: Display LVGL Meter Widget
|
|
...
|
|
```
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
* Why the LCD doesn't light up?
|
|
* Check the backlight's turn-on level, and update it in `EXAMPLE_LCD_BK_LIGHT_ON_LEVEL`
|
|
* Weird color display?
|
|
* Each LCD panel has it's own initialize code, see the `vendor_specific_init` array defined in [GC9A01 driver](main/esp_lcd_panel_gc9a01.c), where contains the Gama setting. You should consult your the LCD supplier.
|
|
|
|
For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. |