diff --git a/components/esp_lcd/test/test_i2c_lcd_panel.c b/components/esp_lcd/test/test_i2c_lcd_panel.c index 3705c8a31e..a62af2666d 100644 --- a/components/esp_lcd/test/test_i2c_lcd_panel.c +++ b/components/esp_lcd/test/test_i2c_lcd_panel.c @@ -71,59 +71,3 @@ TEST_CASE("lcd panel with i2c interface (ssd1306)", "[lcd]") TEST_ESP_OK(esp_lcd_panel_io_del(io_handle)); TEST_ESP_OK(i2c_driver_delete(TEST_I2C_HOST_ID)); } - -// The following test shows a porting example of LVGL GUI library -// To run the LVGL tests, you need to clone the LVGL library into components directory firstly -#if CONFIG_LV_USE_USER_DATA -#include "test_lvgl_port.h" -#if CONFIG_LV_COLOR_DEPTH_1 -static bool notify_lvgl_ready_to_flush(esp_lcd_panel_io_handle_t panel_io, esp_lcd_panel_io_event_data_t *edata, void *user_ctx) -{ - lv_disp_t *disp = *(lv_disp_t **)user_ctx; - lv_disp_flush_ready(&disp->driver); - return false; -} - -TEST_CASE("lvgl gui with i2c interface (ssd1306)", "[lcd][lvgl][ignore]") -{ - // initialize LVGL graphics library - lv_disp_t *disp = NULL; - lv_init(); - - i2c_config_t conf = { - .mode = I2C_MODE_MASTER, - .sda_io_num = TEST_I2C_SDA_GPIO, - .scl_io_num = TEST_I2C_SCL_GPIO, - .sda_pullup_en = GPIO_PULLUP_ENABLE, - .scl_pullup_en = GPIO_PULLUP_ENABLE, - .master.clk_speed = TEST_LCD_PIXEL_CLOCK_HZ, - }; - TEST_ESP_OK(i2c_param_config(TEST_I2C_HOST_ID, &conf)); - TEST_ESP_OK(i2c_driver_install(TEST_I2C_HOST_ID, I2C_MODE_MASTER, 0, 0, 0)); - - esp_lcd_panel_io_handle_t io_handle = NULL; - esp_lcd_panel_io_i2c_config_t io_config = { - .dev_addr = TEST_I2C_DEV_ADDR, - .control_phase_bytes = 1, // According to SSD1306 datasheet - .dc_bit_offset = 6, // According to SSD1306 datasheet - .lcd_cmd_bits = 8, // According to SSD1306 datasheet - .lcd_param_bits = 8, // According to SSD1306 datasheet - .on_color_trans_done = notify_lvgl_ready_to_flush, - .user_ctx = &disp, - }; - TEST_ESP_OK(esp_lcd_new_panel_io_i2c((esp_lcd_i2c_bus_handle_t)TEST_I2C_HOST_ID, &io_config, &io_handle)); - - esp_lcd_panel_handle_t panel_handle = NULL; - esp_lcd_panel_dev_config_t panel_config = { - .bits_per_pixel = 1, - .color_space = ESP_LCD_COLOR_SPACE_MONOCHROME, - .reset_gpio_num = -1, - }; - TEST_ESP_OK(esp_lcd_new_panel_ssd1306(io_handle, &panel_config, &panel_handle)); - TEST_ESP_OK(esp_lcd_panel_reset(panel_handle)); - TEST_ESP_OK(esp_lcd_panel_init(panel_handle)); - - test_lvgl_task_loop(panel_handle, TEST_LCD_H_RES, TEST_LCD_V_RES, &disp); -} -#endif // CONFIG_LV_COLOR_DEPTH_1 -#endif // CONFIG_LV_USE_USER_DATA diff --git a/components/esp_lcd/test/test_lvgl_port_v7.c b/components/esp_lcd/test/test_lvgl_port_v7.c index a81f118c01..535897c059 100644 --- a/components/esp_lcd/test/test_lvgl_port_v7.c +++ b/components/esp_lcd/test/test_lvgl_port_v7.c @@ -19,27 +19,6 @@ static void my_lvgl_flush(lv_disp_drv_t *drv, const lv_area_t *area, lv_color_t esp_lcd_panel_draw_bitmap(panel_handle, offsetx1, offsety1, offsetx2 + 1, offsety2 + 1, color_map); } -#if CONFIG_LV_COLOR_DEPTH_1 -static void my_lvgl_set_px_cb(lv_disp_drv_t *disp_drv, uint8_t *buf, lv_coord_t buf_w, lv_coord_t x, lv_coord_t y, - lv_color_t color, lv_opa_t opa) -{ - uint16_t byte_index = x + (( y >> 3 ) * buf_w); - uint8_t bit_index = y & 0x7; - - if ((color.full == 0) && (LV_OPA_TRANSP != opa)) { - buf[byte_index] |= (1 << bit_index); - } else { - buf[byte_index] &= ~(1 << bit_index); - } -} - -static void my_lvgl_rounder(lv_disp_drv_t *disp_drv, lv_area_t *area) -{ - area->y1 = (area->y1 & (~0x7)); - area->y2 = (area->y2 & (~0x7)) + 7; -} -#endif - static void increase_lvgl_tick(void) { lv_tick_inc(portTICK_PERIOD_MS); @@ -56,7 +35,6 @@ static void create_demo_application(lv_disp_t *disp) // Align the Label to the center lv_obj_align(label, NULL, LV_ALIGN_IN_TOP_MID, 0, 0); -#if !CONFIG_LV_COLOR_DEPTH_1 // new screen_spinner lv_obj_t *screen_spinner = lv_spinner_create(scr, NULL); lv_obj_align(screen_spinner, label, LV_ALIGN_OUT_BOTTOM_MID, 15, 20); @@ -71,7 +49,6 @@ static void create_demo_application(lv_disp_t *disp) lv_obj_align(bar, screen_spinner, LV_ALIGN_OUT_BOTTOM_MID, 0, 0); lv_bar_set_anim_time(bar, 2000); lv_bar_set_value(bar, 100, LV_ANIM_ON); -#endif } void test_lvgl_task_loop(esp_lcd_panel_handle_t panel_handle, int h_res, int v_res, lv_disp_t **disp) @@ -89,10 +66,6 @@ void test_lvgl_task_loop(esp_lcd_panel_handle_t panel_handle, int h_res, int v_r disp_drv.hor_res = h_res; disp_drv.ver_res = v_res; disp_drv.flush_cb = my_lvgl_flush; -#if CONFIG_LV_COLOR_DEPTH_1 - disp_drv.rounder_cb = my_lvgl_rounder; - disp_drv.set_px_cb = my_lvgl_set_px_cb; -#endif disp_drv.buffer = &disp_buf; disp_drv.user_data = panel_handle; // LV_USE_USER_DATA is disabled by default, need to enable it in menuconfig diff --git a/docs/en/api-reference/peripherals/lcd.rst b/docs/en/api-reference/peripherals/lcd.rst index a878f8d67d..68d6bcc450 100644 --- a/docs/en/api-reference/peripherals/lcd.rst +++ b/docs/en/api-reference/peripherals/lcd.rst @@ -26,6 +26,7 @@ LCD examples are located under: :example:`peripherals/lcd`: * i80 controller based LCD and LVGL animation UI - :example:`peripherals/lcd/i80_controller` * GC9A01 user customized driver and dash board UI - :example:`peripherals/lcd/gc9a01` * RGB panel example with scatter chart UI - :example:`peripherals/lcd/rgb_panel` +* I2C interfaced OLED display scrolling text - :example:`peripherals/lcd/i2c_oled` API Reference ------------- diff --git a/examples/peripherals/lcd/gc9a01/main/idf_component.yml b/examples/peripherals/lcd/gc9a01/main/idf_component.yml index c5592991c9..eedaf75ade 100644 --- a/examples/peripherals/lcd/gc9a01/main/idf_component.yml +++ b/examples/peripherals/lcd/gc9a01/main/idf_component.yml @@ -1,3 +1,3 @@ dependencies: idf: ">=4.4" - lvgl/lvgl: "==8.0.2" + lvgl/lvgl: "~8.0.2" diff --git a/examples/peripherals/lcd/gc9a01/sdkconfig.defaults b/examples/peripherals/lcd/gc9a01/sdkconfig.defaults index a2ac6edd21..06bb9fb0bf 100644 --- a/examples/peripherals/lcd/gc9a01/sdkconfig.defaults +++ b/examples/peripherals/lcd/gc9a01/sdkconfig.defaults @@ -1,2 +1,3 @@ CONFIG_LV_USE_USER_DATA=y CONFIG_LV_COLOR_16_SWAP=y +CONFIG_LV_COLOR_DEPTH_16=y diff --git a/examples/peripherals/lcd/i2c_oled/CMakeLists.txt b/examples/peripherals/lcd/i2c_oled/CMakeLists.txt new file mode 100644 index 0000000000..d1180c30fa --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/CMakeLists.txt @@ -0,0 +1,9 @@ +cmake_minimum_required(VERSION 3.5) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(i2c_oled) + +# As the upstream LVGL library has build warnings in esp-idf build system, this is only for temporarily workaround +# Will remove this workaround when upstream LVGL fixes the warnings in the next release +idf_component_get_property(lvgl_lib lvgl__lvgl COMPONENT_LIB) +target_compile_options(${lvgl_lib} PRIVATE "-Wno-empty-body" "-Wno-strict-prototypes") diff --git a/examples/peripherals/lcd/i2c_oled/README.md b/examples/peripherals/lcd/i2c_oled/README.md new file mode 100644 index 0000000000..04f08fcb8e --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/README.md @@ -0,0 +1,61 @@ +# I2C OLED example + +[esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/lcd.html) supports I2C interfaced OLED LCD, whose color depth is usually 1bpp. + +This example shows how to make use of the SSD1306 panel driver from `esp_lcd` component to facilitate the porting of LVGL library. In the end, example will display a scrolling text on the OLED screen. For more information about porting the LVGL library, you can also refer to another [lvgl porting example](../i80_controller/README.md). + +## How to use the example + +### Hardware Required + +* An ESP development board +* An SSD1306 OLED LCD, with I2C interface +* An USB cable for power supply and programming + +### Hardware Connection + +The connection between ESP Board and the LCD is as follows: + +``` + ESP Board OLED LCD (I2C) ++------------------+ +-------------------+ +| GND+--------------+GND | +| | | | +| 3V3+--------------+VCC | +| | | | +| SDA+--------------+SDA | +| | | | +| SCL+--------------+SCL | ++------------------+ +-------------------+ +``` + +The GPIO number used by this example can be changed in [lvgl_example_main.c](main/i2c_oled_example_main.c). Please pay attention to the I2C hardware device address as well, you should refer to your module's spec and schematic to determine that address. + +### Build and Flash + +Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A scrolling text 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 (0) cpu_start: Starting scheduler on APP CPU. +I (345) example: Initialize I2C bus +I (345) example: Install panel IO +I (345) example: Install SSD1306 panel driver +I (455) example: Initialize LVGL library +I (455) example: Register display driver to LVGL +I (455) example: Install LVGL tick timer +I (455) example: Display LVGL Scroll Text +... +``` + +## Troubleshooting + +For any technical queries, please open an [issue] (https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. \ No newline at end of file diff --git a/examples/peripherals/lcd/i2c_oled/main/CMakeLists.txt b/examples/peripherals/lcd/i2c_oled/main/CMakeLists.txt new file mode 100644 index 0000000000..b40b17ee79 --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "i2c_oled_example_main.c" "lvgl_demo_ui.c" + INCLUDE_DIRS ".") diff --git a/examples/peripherals/lcd/i2c_oled/main/i2c_oled_example_main.c b/examples/peripherals/lcd/i2c_oled/main/i2c_oled_example_main.c new file mode 100644 index 0000000000..e6b8c5cf61 --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/main/i2c_oled_example_main.c @@ -0,0 +1,170 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: CC0-1.0 + */ + +#include +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "esp_timer.h" +#include "esp_lcd_panel_io.h" +#include "esp_lcd_panel_vendor.h" +#include "esp_lcd_panel_ops.h" +#include "driver/i2c.h" +#include "esp_err.h" +#include "esp_log.h" +#include "lvgl.h" + +static const char *TAG = "example"; + +#define I2C_HOST 0 + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +//////////////////// Please update the following configuration according to your LCD spec ////////////////////////////// +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#define EXAMPLE_LCD_PIXEL_CLOCK_HZ (400 * 1000) +#define EXAMPLE_PIN_NUM_SDA 3 +#define EXAMPLE_PIN_NUM_SCL 4 +#define EXAMPLE_PIN_NUM_RST -1 +#define EXAMPLE_I2C_HW_ADDR 0x3C + +// The pixel number in horizontal and vertical +#define EXAMPLE_LCD_H_RES 128 +#define EXAMPLE_LCD_V_RES 64 +// Bit number used to represent command and parameter +#define EXAMPLE_LCD_CMD_BITS 8 +#define EXAMPLE_LCD_PARAM_BITS 8 + +#define EXAMPLE_LVGL_TICK_PERIOD_MS 2 + +extern void example_lvgl_demo_ui(lv_obj_t *scr); + +static bool example_notify_lvgl_flush_ready(esp_lcd_panel_io_handle_t panel_io, esp_lcd_panel_io_event_data_t *edata, void *user_ctx) +{ + lv_disp_drv_t *disp_driver = (lv_disp_drv_t *)user_ctx; + lv_disp_flush_ready(disp_driver); + return false; +} + +static void example_lvgl_flush_cb(lv_disp_drv_t *drv, const lv_area_t *area, lv_color_t *color_map) +{ + esp_lcd_panel_handle_t panel_handle = (esp_lcd_panel_handle_t) drv->user_data; + int offsetx1 = area->x1; + int offsetx2 = area->x2; + int offsety1 = area->y1; + int offsety2 = area->y2; + // copy a buffer's content to a specific area of the display + esp_lcd_panel_draw_bitmap(panel_handle, offsetx1, offsety1, offsetx2 + 1, offsety2 + 1, color_map); +} + +static void example_lvgl_set_px_cb(lv_disp_drv_t *disp_drv, uint8_t *buf, lv_coord_t buf_w, lv_coord_t x, lv_coord_t y, + lv_color_t color, lv_opa_t opa) +{ + uint16_t byte_index = x + (( y >> 3 ) * buf_w); + uint8_t bit_index = y & 0x7; + + if ((color.full == 0) && (LV_OPA_TRANSP != opa)) { + buf[byte_index] |= (1 << bit_index); + } else { + buf[byte_index] &= ~(1 << bit_index); + } +} + +static void example_lvgl_rounder(lv_disp_drv_t *disp_drv, lv_area_t *area) +{ + area->y1 = area->y1 & (~0x7); + area->y2 = area->y2 | 0x7; +} + +static void example_increase_lvgl_tick(void *arg) +{ + /* Tell LVGL how many milliseconds has elapsed */ + lv_tick_inc(EXAMPLE_LVGL_TICK_PERIOD_MS); +} + +void app_main(void) +{ + static lv_disp_draw_buf_t disp_buf; // contains internal graphic buffer(s) called draw buffer(s) + static lv_disp_drv_t disp_drv; // contains callback functions + + ESP_LOGI(TAG, "Initialize I2C bus"); + i2c_config_t i2c_conf = { + .mode = I2C_MODE_MASTER, + .sda_io_num = EXAMPLE_PIN_NUM_SDA, + .scl_io_num = EXAMPLE_PIN_NUM_SCL, + .sda_pullup_en = GPIO_PULLUP_ENABLE, + .scl_pullup_en = GPIO_PULLUP_ENABLE, + .master.clk_speed = EXAMPLE_LCD_PIXEL_CLOCK_HZ, + }; + ESP_ERROR_CHECK(i2c_param_config(I2C_HOST, &i2c_conf)); + ESP_ERROR_CHECK(i2c_driver_install(I2C_HOST, I2C_MODE_MASTER, 0, 0, 0)); + + ESP_LOGI(TAG, "Install panel IO"); + esp_lcd_panel_io_handle_t io_handle = NULL; + esp_lcd_panel_io_i2c_config_t io_config = { + .dev_addr = EXAMPLE_I2C_HW_ADDR, + .control_phase_bytes = 1, // According to SSD1306 datasheet + .dc_bit_offset = 6, // According to SSD1306 datasheet + .lcd_cmd_bits = EXAMPLE_LCD_CMD_BITS, // According to SSD1306 datasheet + .lcd_param_bits = EXAMPLE_LCD_CMD_BITS, // According to SSD1306 datasheet + .on_color_trans_done = example_notify_lvgl_flush_ready, + .user_ctx = &disp_drv, + }; + ESP_ERROR_CHECK(esp_lcd_new_panel_io_i2c((esp_lcd_i2c_bus_handle_t)I2C_HOST, &io_config, &io_handle)); + + ESP_LOGI(TAG, "Install SSD1306 panel driver"); + esp_lcd_panel_handle_t panel_handle = NULL; + esp_lcd_panel_dev_config_t panel_config = { + .bits_per_pixel = 1, + .color_space = ESP_LCD_COLOR_SPACE_MONOCHROME, + .reset_gpio_num = EXAMPLE_PIN_NUM_RST, + }; + ESP_ERROR_CHECK(esp_lcd_new_panel_ssd1306(io_handle, &panel_config, &panel_handle)); + + ESP_ERROR_CHECK(esp_lcd_panel_reset(panel_handle)); + ESP_ERROR_CHECK(esp_lcd_panel_init(panel_handle)); + + ESP_LOGI(TAG, "Initialize LVGL library"); + lv_init(); + // alloc draw buffers used by LVGL + // it's recommended to choose the size of the draw buffer(s) to be at least 1/10 screen sized + lv_color_t *buf1 = malloc(EXAMPLE_LCD_H_RES * 20 * sizeof(lv_color_t)); + assert(buf1); + lv_color_t *buf2 = malloc(EXAMPLE_LCD_H_RES * 20 * sizeof(lv_color_t)); + assert(buf2); + // initialize LVGL draw buffers + lv_disp_draw_buf_init(&disp_buf, buf1, buf2, EXAMPLE_LCD_H_RES * 20); + + ESP_LOGI(TAG, "Register display driver to LVGL"); + lv_disp_drv_init(&disp_drv); + disp_drv.hor_res = EXAMPLE_LCD_H_RES; + disp_drv.ver_res = EXAMPLE_LCD_V_RES; + disp_drv.flush_cb = example_lvgl_flush_cb; + disp_drv.draw_buf = &disp_buf; + disp_drv.user_data = panel_handle; + disp_drv.rounder_cb = example_lvgl_rounder; + disp_drv.set_px_cb = example_lvgl_set_px_cb; + lv_disp_t *disp = lv_disp_drv_register(&disp_drv); + + ESP_LOGI(TAG, "Install LVGL tick timer"); + // Tick interface for LVGL (using esp_timer to generate 2ms periodic event) + const esp_timer_create_args_t lvgl_tick_timer_args = { + .callback = &example_increase_lvgl_tick, + .name = "lvgl_tick" + }; + esp_timer_handle_t lvgl_tick_timer = NULL; + ESP_ERROR_CHECK(esp_timer_create(&lvgl_tick_timer_args, &lvgl_tick_timer)); + ESP_ERROR_CHECK(esp_timer_start_periodic(lvgl_tick_timer, EXAMPLE_LVGL_TICK_PERIOD_MS * 1000)); + + ESP_LOGI(TAG, "Display LVGL Scroll Text"); + lv_obj_t *scr = lv_disp_get_scr_act(disp); + example_lvgl_demo_ui(scr); + + while (1) { + // raise the task priority of LVGL and/or reduce the handler period can improve the performance + vTaskDelay(pdMS_TO_TICKS(10)); + // The task running lv_timer_handler should have lower priority than that running `lv_tick_inc` + lv_timer_handler(); + } +} diff --git a/examples/peripherals/lcd/i2c_oled/main/idf_component.yml b/examples/peripherals/lcd/i2c_oled/main/idf_component.yml new file mode 100644 index 0000000000..eedaf75ade --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/main/idf_component.yml @@ -0,0 +1,3 @@ +dependencies: + idf: ">=4.4" + lvgl/lvgl: "~8.0.2" diff --git a/examples/peripherals/lcd/i2c_oled/main/lvgl_demo_ui.c b/examples/peripherals/lcd/i2c_oled/main/lvgl_demo_ui.c new file mode 100644 index 0000000000..a8d0ee9d6a --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/main/lvgl_demo_ui.c @@ -0,0 +1,16 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: CC0-1.0 + */ + +#include "lvgl.h" + +void example_lvgl_demo_ui(lv_obj_t *scr) +{ + lv_obj_t *label = lv_label_create(scr); + lv_label_set_long_mode(label, LV_LABEL_LONG_SCROLL_CIRCULAR); /* Circular scroll */ + lv_label_set_text(label, "Hello Espressif, Hello LVGL."); + lv_obj_set_width(label, 150); + lv_obj_align(label, LV_ALIGN_TOP_MID, 0, 0); +} diff --git a/examples/peripherals/lcd/i2c_oled/sdkconfig.defaults b/examples/peripherals/lcd/i2c_oled/sdkconfig.defaults new file mode 100644 index 0000000000..d92efacc71 --- /dev/null +++ b/examples/peripherals/lcd/i2c_oled/sdkconfig.defaults @@ -0,0 +1,5 @@ +# This file was generated using idf.py save-defconfig. It can be edited manually. +# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration +# +CONFIG_LV_USE_USER_DATA=y +CONFIG_LV_COLOR_DEPTH_1=y diff --git a/examples/peripherals/lcd/i80_controller/sdkconfig.defaults b/examples/peripherals/lcd/i80_controller/sdkconfig.defaults index c111342bb6..26b18c22e0 100644 --- a/examples/peripherals/lcd/i80_controller/sdkconfig.defaults +++ b/examples/peripherals/lcd/i80_controller/sdkconfig.defaults @@ -3,3 +3,4 @@ CONFIG_LV_MEMCPY_MEMSET_STD=y CONFIG_LV_USE_PERF_MONITOR=y CONFIG_LV_USE_USER_DATA=y CONFIG_LV_COLOR_16_SWAP=y +CONFIG_LV_COLOR_DEPTH_16=y