| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 | | ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | # 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. ## LVGL Version This example is using the **LVGL8** version. For use it with LVGL9 version, please delete file [sdkconfig.defaults](sdkconfig.defaults) and change version to `"^9"` on this line in [idf_component.yml](main/idf_component.yml) file: ``` lvgl/lvgl: "^8" ``` NOTE: When you are changing LVGL versions, please remove these files and folders before new build: - build/ - managed_components/ - dependencies.lock - sdkconfig ## 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 ... ```
To create a project from this example, run:
idf.py create-project-from-example "espressif/esp_lvgl_port^2.4.3:i2c_oled"