espressif/esp_lcd_spd2010
uploaded 3 weeks ago

ESP LCD SPD2010

readme

# ESP LCD SPD2010 [![Component Registry](https://components.espressif.com/components/espressif/esp_lcd_spd2010/badge.svg)](https://components.espressif.com/components/espressif/esp_lcd_spd2010) Implementation of the SPD2010 LCD controller with [esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-reference/peripherals/lcd.html) component. | LCD controller | Communication interface | Component name | Link to datasheet | | :------------: | :---------------------: | :-------------: | :-----------------------------------------------------------------------------: | | SPD2010 | SPI/QSPI | esp_lcd_spd2010 | [PDF](https://dl.espressif.com/AE/esp-iot-solution/SPD2010(L-WEA2010)_0.50.pdf) | ## Add to project Packages from this repository are uploaded to [Espressif's component service](https://components.espressif.com/). You can add them to your project via `idf.py add-dependancy`, e.g. ``` idf.py add-dependency "espressif/esp_lcd_spd2010" ``` Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html). ## Initialization Code ### SPI Interface ```c ESP_LOGI(TAG, "Initialize SPI bus"); const spi_bus_config_t bus_config = SPD2010_PANEL_BUS_SPI_CONFIG(EXAMPLE_PIN_NUM_LCD_PCLK, EXAMPLE_PIN_NUM_LCD_DATA0, EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t)); ESP_ERROR_CHECK(spi_bus_initialize(EXAMPLE_LCD_HOST, &bus_config, SPI_DMA_CH_AUTO)); ESP_LOGI(TAG, "Install panel IO"); esp_lcd_panel_io_handle_t io_handle = NULL; const esp_lcd_panel_io_spi_config_t io_config = SPD2010_PANEL_IO_SPI_CONFIG(EXAMPLE_PIN_NUM_LCD_CS, EXAMPLE_PIN_NUM_LCD_DC, callback, &callback_data); ESP_ERROR_CHECK(esp_lcd_new_panel_io_spi((esp_lcd_spi_bus_handle_t)EXAMPLE_LCD_HOST, &io_config, &io_handle)); /** * Uncomment these line if use custom initialization commands. * The array should be declared as static const and positioned outside the function. */ // static const spd2010_lcd_init_cmd_t lcd_init_cmds[] = { // // {cmd, { data }, data_size, delay_ms} // {0xFF, (uint8_t []){0x20, 0x10, 0x10}, 3, 0}, // {0x0C, (uint8_t []){0x11}, 1, 0}, // {0x10, (uint8_t []){0x02}, 1, 0}, // {0x11, (uint8_t []){0x11}, 1, 0}, // ... // }; ESP_LOGI(TAG, "Install SPD2010 panel driver"); esp_lcd_panel_handle_t panel_handle = NULL; const spd2010_vendor_config_t vendor_config = { // .init_cmds = lcd_init_cmds, // Uncomment these line if use custom initialization commands // .init_cmds_size = sizeof(lcd_init_cmds) / sizeof(spd2010_lcd_init_cmd_t), .flags = { .use_qspi_interface = 0, }, }; const esp_lcd_panel_dev_config_t panel_config = { .reset_gpio_num = EXAMPLE_PIN_NUM_LCD_RST, .rgb_ele_order = LCD_RGB_ELEMENT_ORDER_RGB, // Implemented by LCD command `36h` .bits_per_pixel = 16, // Implemented by LCD command `3Ah` (16/18/24) .vendor_config = &vendor_config, }; ESP_ERROR_CHECK(esp_lcd_new_panel_spd2010(io_handle, &panel_config, &panel_handle)); esp_lcd_panel_reset(panel_handle); esp_lcd_panel_init(panel_handle); ``` ### QSPI Interface ```c ESP_LOGI(TAG, "Initialize QSPI bus"); const esp_lcd_panel_io_spi_config_t io_config = SPD2010_PANEL_BUS_QSPI_CONFIG(EXAMPLE_PIN_NUM_LCD_PCLK, EXAMPLE_PIN_NUM_LCD_DATA0, EXAMPLE_PIN_NUM_LCD_DATA1, EXAMPLE_PIN_NUM_LCD_DATA2, EXAMPLE_PIN_NUM_LCD_DATA3, EXAMPLE_LCD_H_RES * 80 * sizeof(uint16_t)); ESP_ERROR_CHECK(spi_bus_initialize(EXAMPLE_LCD_HOST, &buscfg, SPI_DMA_CH_AUTO)); ESP_LOGI(TAG, "Install panel IO"); esp_lcd_panel_io_handle_t io_handle = NULL; const esp_lcd_panel_io_spi_config_t io_config = SPD2010_PANEL_IO_QSPI_CONFIG(EXAMPLE_PIN_NUM_LCD_CS, callback, &callback_data); ESP_ERROR_CHECK(esp_lcd_new_panel_io_spi((esp_lcd_spi_bus_handle_t)EXAMPLE_LCD_HOST, &io_config, &io_handle)); /** * Uncomment these line if use custom initialization commands. * The array should be declared as static const and positioned outside the function. */ // static const spd2010_lcd_init_cmd_t lcd_init_cmds[] = { // // {cmd, { data }, data_size, delay_ms} // {0xFF, (uint8_t []){0x20, 0x10, 0x10}, 3, 0}, // {0x0C, (uint8_t []){0x11}, 1, 0}, // {0x10, (uint8_t []){0x02}, 1, 0}, // {0x11, (uint8_t []){0x11}, 1, 0}, // ... // }; ESP_LOGI(TAG, "Install SPD2010 panel driver"); esp_lcd_panel_handle_t panel_handle = NULL; const spd2010_vendor_config_t vendor_config = { // .init_cmds = lcd_init_cmds, // Uncomment these line if use custom initialization commands // .init_cmds_size = sizeof(lcd_init_cmds) / sizeof(spd2010_lcd_init_cmd_t), .flags = { .use_qspi_interface = 1, }, }; const esp_lcd_panel_dev_config_t panel_config = { .reset_gpio_num = EXAMPLE_PIN_NUM_LCD_RST, .rgb_ele_order = LCD_RGB_ELEMENT_ORDER_RGB, // Implemented by LCD command `36h` .bits_per_pixel = 16, // Implemented by LCD command `3Ah` (16/18/24) .vendor_config = &vendor_config, }; ESP_ERROR_CHECK(esp_lcd_new_panel_spd2010(io_handle, &panel_config, &panel_handle)); esp_lcd_panel_reset(panel_handle); esp_lcd_panel_init(panel_handle); esp_lcd_panel_disp_on_off(panel_handle, true); ``` ## Notes * When using `esp_panel_lcd_draw_bitmap()` to refresh the screen, ensure that both `x_start` and `x_end` are divisible by `4`. This is a requirement of SPD2010. For LVGL, register the following function into `rounder_cb` of `lv_disp_drv_t` to round the coordinates. ```c void lvgl_port_rounder_callback(struct _lv_disp_drv_t * disp_drv, lv_area_t * area) { uint16_t x1 = area->x1; uint16_t x2 = area->x2; // round the start of coordinate down to the nearest 4M number area->x1 = (x1 >> 2) << 2; // round the end of coordinate up to the nearest 4N+3 number area->x2 = ((x2 >> 2) << 2) + 3; } ```

changelog

# ChangeLog ## v0.0.1 - 2023-08-22 ### Enhancements: * Implement the driver for the SPD2010 LCD controller * Support SPI and QSPI interface ## v0.0.2 - 2023-10-07 ### Enhancements: * Support to use ESP-IDF release/v5.0 ## v1.0.0 - 2023-11-03 ### bugfix * Fix the incompatible dependent version of ESP-IDF * Remove LCD command `29h` from the initialization sequence * Add parameter `max_trans_sz` in default bus configuration macro * Check conflicting commands between initialization sequence and driver

readme of qspi_with_ram example

| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 | | ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | | Supported LCD Controllers | SPD2010 | GC9B71 | SH8601 | | ------------------------- | ------- | ------ | ------ | # QSPI LCD (with RAM) and Touch Panel 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 use SPD1020, GC9B71 or SH8601 display driver from Component manager in esp-idf project. These components are using API provided by `esp_lcd` component. This example will draw a fancy dash board with the LVGL library. This example uses the [esp_timer](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/esp_timer.html) to generate the ticks needed by LVGL and uses a dedicated task to run the `lv_timer_handler()`. Since the LVGL APIs are not thread-safe, this example uses a mutex which be invoked before the call of `lv_timer_handler()` and released after it. The same mutex needs to be used in other tasks and threads around every LVGL (lv_...) related function call and code. For more porting guides, please refer to [LVGL porting doc](https://docs.lvgl.io/master/porting/index.html). ## Touch controller In this example you can enable touch controller SPD2010 or CST816 connected via I2C. ## How to use the example ### Hardware Required * An ESP development board * A SPD1020, GC9B71 or SH8601 LCD panel, with QSPI interface (with/without touch) * An USB cable for power supply and programming ### Hardware Connection The connection between ESP Board and the LCD is as follows: ``` ESP Board SPD1020, GC9B71 or SH8601 Panel (QSPI) ┌──────────────────────┐ ┌────────────────────┐ │ GND ├─────────────►│ GND │ │ │ │ │ │ 3V3 ├─────────────►│ VCC │ │ │ │ │ │ CS ├─────────────►│ CS │ │ │ │ │ │ SCK ├─────────────►│ CLK │ │ │ │ │ │ D3 ├─────────────►│ IO3 │ │ │ │ │ │ D2 ├─────────────►│ IO2 │ │ │ │ │ │ D1 ├─────────────►│ IO1 │ │ │ │ │ │ D0 ├─────────────►│ IO0 │ │ │ │ │ │ RST ├─────────────►│ RSTN │ │ │ │ │ │ (SCL) ├─────────────►│ TP_SCL │ │ │ │ │ │ (SDA) ├─────────────►│ TP_SDA │ │ │ │ │ │ (TP_INT) ├─────────────►│ TP_INT │ │ │ │ │ │ (3V3) ├─────────────►│ TP_RST │ │ │ │ │ └──────────────────────┘ └────────────────────┘ ``` The GPIO number used by this example can be changed in [example_qspi_with_ram.c](main/example_qspi_with_ram.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 [example_qspi_with_ram.c](main/example_qspi_with_ram.c). The LCD vendor specific initialization can be different between manufacturers and should consult the LCD supplier for initialization sequence code. ### 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 (415) example: Turn off LCD backlight I (420) gpio: GPIO[0]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0 I (429) example: Initialize SPI bus I (434) example: Install panel IO I (438) example: Install SPD2010 panel driver I (442) gpio: GPIO[17]| InputEn: 0| OutputEn: 1| OpenDrain: 0| Pullup: 0| Pulldown: 0| Intr:0 I (452) spd2010: LCD panel create success, version: 0.0.1 I (741) example: Turn on LCD backlight I (741) example: Initialize LVGL library I (741) example: Register display driver to LVGL I (746) example: Install LVGL tick timer I (748) example: Starting LVGL task I (795) example: Display LVGL demos I (1038) main_task: Returned from app_main() ... ``` ## Troubleshooting For any technical queries, please open an [issue] (https://github.com/espressif/esp-iot-solution/issues) on GitHub. We will get back to you soon.

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/esp_lcd_spd2010^1.0.0"

or download archive

Dependencies

  • espressif/cmake_utilities 0.*
  • ESP-IDF >5.0.4,!=5.1.1
  • Examples:

    qspi_with_ram

    more details

    Stats

    • Downloaded in total
      Downloaded in total 31 times
    • Downloaded this version
      This version: 6 times

    Badge

    espressif/esp_lcd_spd2010 version: 1.0.0 |