espressif/esp_lcd_st7701

# ESP LCD ST7701(S) [![Component Registry](https://components.espressif.com/components/espressif/esp_lcd_st7701/badge.svg)](https://components.espressif.com/components/espressif/esp_lcd_st7701) Implementation of the ST7701(S) LCD controller with esp_lcd component. | LCD controller | Communication interface | Component name | Link to datasheet | | :------------: | :---------------------: | :------------: | :--------------------------------------------------------------------------: | | ST7701(S) | 3-wire SPI + RGB / MIPI-DSI | esp_lcd_st7701 | [PDF](https://dl.espressif.com/AE/esp-iot-solution/ST7701S_SPEC_%20V1.4.pdf) | **Note**: MIPI-DSI interface only supports ESP-IDF v5.3 and above versions. For more information on LCD, please refer to the [LCD documentation](https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/lcd/index.html). ## 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_st7701" ``` 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). ## Example use ### RGB Interface For most RGB LCDs, they typically use a "3-Wire SPI + Parallel RGB" interface. The "3-Wire SPI" interface is used for transmitting command data and the "Parallel RGB" interface is used for sending pixel data. It's recommended to use the [esp_lcd_panel_io_additions](https://components.espressif.com/components/espressif/esp_lcd_panel_io_additions) component to bit-bang the "3-Wire SPI" interface through **GPIO** or an **IO expander** (like [TCA9554](https://components.espressif.com/components/espressif/esp_io_expander_tca9554)). To do this, please first add this component to your project manually. Then, refer to the following code to initialize the GC9503 controller. ```c ESP_LOGI(TAG, "Install 3-wire SPI panel IO"); spi_line_config_t line_config = { .cs_io_type = IO_TYPE_EXPANDER, // Set to `IO_TYPE_GPIO` if using GPIO, same to below .cs_gpio_num = EXAMPLE_LCD_IO_SPI_CS, .scl_io_type = IO_TYPE_GPIO, .scl_gpio_num = EXAMPLE_LCD_IO_SPI_SCK, .sda_io_type = IO_TYPE_GPIO, .sda_gpio_num = EXAMPLE_LCD_IO_SPI_SDO, .io_expander = NULL, // Set to NULL if not using IO expander }; esp_lcd_panel_io_3wire_spi_config_t io_config = ST7701_PANEL_IO_3WIRE_SPI_CONFIG(line_config, 0); esp_lcd_panel_io_handle_t io_handle = NULL; ESP_ERROR_CHECK(esp_lcd_new_panel_io_3wire_spi(&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 st7701_lcd_init_cmd_t lcd_init_cmds[] = { // // cmd data data_size delay_ms // {0xFF, (uint8_t []){0x77, 0x01, 0x00, 0x00, 0x13}, 5, 0}, // {0xEF, (uint8_t []){0x08}, 1, 0}, // {0xFF, (uint8_t []){0x77, 0x01, 0x00, 0x00, 0x10}, 5, 0}, // {0xC0, (uint8_t []){0x3B, 0x00}, 2, 0}, // ... // }; ESP_LOGI(TAG, "Install ST7701 panel driver"); esp_lcd_rgb_panel_config_t rgb_config = { .clk_src = LCD_CLK_SRC_DEFAULT, .psram_trans_align = 64, .data_width = 16, .bits_per_pixel = 16, .de_gpio_num = EXAMPLE_LCD_IO_RGB_DE, .pclk_gpio_num = EXAMPLE_LCD_IO_RGB_PCLK, .vsync_gpio_num = EXAMPLE_LCD_IO_RGB_VSYNC, .hsync_gpio_num = EXAMPLE_LCD_IO_RGB_HSYNC, .disp_gpio_num = EXAMPLE_LCD_IO_RGB_DISP, .data_gpio_nums = { EXAMPLE_LCD_IO_RGB_DATA0, EXAMPLE_LCD_IO_RGB_DATA1, EXAMPLE_LCD_IO_RGB_DATA2, EXAMPLE_LCD_IO_RGB_DATA3, EXAMPLE_LCD_IO_RGB_DATA4, EXAMPLE_LCD_IO_RGB_DATA5, EXAMPLE_LCD_IO_RGB_DATA6, EXAMPLE_LCD_IO_RGB_DATA7, EXAMPLE_LCD_IO_RGB_DATA8, EXAMPLE_LCD_IO_RGB_DATA9, EXAMPLE_LCD_IO_RGB_DATA10, EXAMPLE_LCD_IO_RGB_DATA11, EXAMPLE_LCD_IO_RGB_DATA12, EXAMPLE_LCD_IO_RGB_DATA13, EXAMPLE_LCD_IO_RGB_DATA14, EXAMPLE_LCD_IO_RGB_DATA15, }, .timings = ST7701_480_480_PANEL_60HZ_RGB_TIMING(), ... }; st7701_vendor_config_t vendor_config = { .rgb_config = &rgb_config, // .init_cmds = lcd_init_cmds, // Uncomment these line if use custom initialization commands // .init_cmds_size = sizeof(lcd_init_cmds) / sizeof(st7701_lcd_init_cmd_t), .flags = { .mirror_by_cmd = 1, // Only work when `enable_io_multiplex` is set to 0 .enable_io_multiplex = 0, /** * Set to 1 if panel IO is no longer needed after LCD initialization. * If the panel IO pins are sharing other pins of the RGB interface to save GPIOs, * Please set it to 1 to release the pins. */ }, }; const esp_lcd_panel_dev_config_t panel_config = { .reset_gpio_num = EXAMPLE_LCD_IO_RST, // Set to -1 if not use .rgb_ele_order = LCD_RGB_ELEMENT_ORDER_RGB, // Implemented by LCD command `36h` .bits_per_pixel = EXAMPLE_LCD_BIT_PER_PIXEL, // Implemented by LCD command `3Ah` (16/18/24) .vendor_config = &vendor_config, }; esp_lcd_panel_handle_t panel_handle = NULL; ESP_ERROR_CHECK(esp_lcd_new_panel_st7701(io_handle, &panel_config, &panel_handle)); /** * Only create RGB when `enable_io_multiplex` is set to 0, * or initialize st7701 meanwhile */ ESP_ERROR_CHECK(esp_lcd_panel_reset(panel_handle)); // Only reset RGB when `enable_io_multiplex` is set to 1, or reset st7701 meanwhile ESP_ERROR_CHECK(esp_lcd_panel_init(panel_handle)); // Only initialize RGB when `enable_io_multiplex` is set to 1, or initialize st7701 meanwhile ``` ### MIPI Interface ```c /** * Uncomment these line if use custom initialization commands. * The array should be declared as static const and positioned outside the function. */ // static const st7701_lcd_init_cmd_t lcd_init_cmds[] = { // // cmd data data_size delay_ms // {0xFF, (uint8_t []){0x77, 0x01, 0x00, 0x00, 0x13}, 5, 0}, // {0xEF, (uint8_t []){0x08}, 1, 0}, // {0xFF, (uint8_t []){0x77, 0x01, 0x00, 0x00, 0x10}, 5, 0}, // {0xC0, (uint8_t []){0x3B, 0x00}, 2, 0}, // ... // }; ESP_LOGI(TAG, "MIPI DSI PHY Powered on"); esp_ldo_channel_config_t ldo_mipi_phy_config = { .chan_id = EXAMPLE_MIPI_DSI_PHY_PWR_LDO_CHAN, .voltage_mv = EXAMPLE_MIPI_DSI_PHY_PWR_LDO_VOLTAGE_MV, }; ESP_ERROR_CHECK(esp_ldo_acquire_channel(&ldo_mipi_phy_config, &ldo_mipi_phy)); ESP_LOGI(TAG, "Initialize MIPI DSI bus"); esp_lcd_dsi_bus_config_t bus_config = ST7701_PANEL_BUS_DSI_2CH_CONFIG(); ESP_ERROR_CHECK(esp_lcd_new_dsi_bus(&bus_config, &mipi_dsi_bus)); ESP_LOGI(TAG, "Install panel IO"); esp_lcd_dbi_io_config_t dbi_config = ST7701_PANEL_IO_DBI_CONFIG(); ESP_ERROR_CHECK(esp_lcd_new_panel_io_dbi(mipi_dsi_bus, &dbi_config, &mipi_dbi_io)); ESP_LOGI(TAG, "Install LCD driver of st7701"); esp_lcd_panel_handle_t panel_handle = NULL; esp_lcd_dpi_panel_config_t dpi_config = ST7701_480_360_PANEL_60HZ_DPI_CONFIG(EXAMPLE_MIPI_DPI_PX_FORMAT); st7701_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(st7701_lcd_init_cmd_t), .flags.use_mipi_interface = 1, .mipi_config = { .dsi_bus = mipi_dsi_bus, .dpi_config = &dpi_config, }, }; 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, .bits_per_pixel = EXAMPLE_LCD_BIT_PER_PIXEL, .vendor_config = &vendor_config, }; ESP_ERROR_CHECK(esp_lcd_new_panel_st7701(mipi_dbi_io, &panel_config, &panel_handle)); ESP_ERROR_CHECK(esp_lcd_panel_reset(panel_handle)); ESP_ERROR_CHECK(esp_lcd_panel_init(panel_handle)); ESP_ERROR_CHECK(esp_lcd_panel_disp_on_off(panel_handle, true)); ```

readme

Links

Targets

License: Apache-2.0

Stats

Badge