Skip to content

Latest commit

 

History

History

squareline_port

README.md

Supported ESP SoCs ESP32 ESP32-C3 ESP32-C6 ESP32-H2 ESP32-S2 ESP32-S3 ESP32-P4

SquareLine Porting Example

Overview

This example demonstrates how to port SquareLine (v1.4.x) project. And for RGB/MIPI-DSI interface LCDs, it can enable the avoid tearing and rotation function.

How to Use

Step 1. Install SDK and dependencies

Step 2. Configure the libraries

  • [Mandatory] ESP32_Display_Panel:

    • This example already has the esp_panel_board_supported_conf.h and esp_panel_board_custom_conf.h configuration files in the project directory. But no board configuration enabled by default, before compiling, please edit the configuration file according to your target board:

      • If using a supported board, edit the esp_panel_board_supported_conf.h file and set ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED to 1. Then uncomment the target board definition in the file
      • If using a custom board, edit the esp_panel_board_custom_conf.h file and set ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM to 1. Then change other configurations as needed in the file

    • This example already has the esp_panel_drivers_conf.h configuration file in the project directory. Edit this file as needed.

    • see Board Configuration Guide for more information

  • [Optional] esp-lib-utils :

  • [Optional] lvgl :

    • This example already has the lv_conf.h configuration file which been modified with the recommended configurations in the project directory
    • Change the LV_COLOR_16_SWAP macro definition to 1 if using SPI/QSPI interface, or 0 if using other interfaces
    • Change other configurations in the file as needed
    • See Configuring LVGL section for more information

Step 3. Configure the example

  • [Optional] Edit the macro definitions in the lvgl_v8_port.h file

    • If using RGB/MIPI-DSI interface, change the LVGL_PORT_AVOID_TEARING_MODE macro definition to 1/2/3 to enable the avoid tearing function. After that, change the LVGL_PORT_ROTATION_DEGREE macro definition to the target rotation degree
    • If using other interfaces, please don't modify the LVGL_PORT_AVOID_TEARING_MODE and LVGL_PORT_ROTATION_DEGREE macro definitions

Step 4. Configure Arduino IDE

  • Navigate to the Tools menu
  • Select the target board in the Board menu
  • Change the Partition Scheme and Flash Size to make the flash size enough for the project (like Huge App + 4MB)
  • Change the PSRAM option to OPI PSRAM if using ESP32S3R8 + RGB LCD, or Enabled if using ESP32P4 + MIPI-DSI LCD
  • Change the USB CDC On Boot option to Enabled if using USB port, or Disabled if using UART port. If this configuration differs from previous flashing, first enable Erase All Flash Before Sketch Upload, then it can be disabled after flashing.
  • Change other configurations as needed
  • see Configuring Arduino IDE for more information

Step 5. Compile and upload the project

  • Connect the board to your computer
  • Select the correct serial port
  • Click the upload button

Step 6. Check the serial output

  • Open the serial monitor and select the correct baud rate (like 115200)
  • Check the output logs

Serial Output

The following are the logs output when using the Espressif:ESP32_S3_LCD_EV_BOARD_2_V1_5 development board. The logs content may vary with different development boards or different configurations, and it is provided for reference only.

...
Initializing board
[I][Panel][esp_panel_board.cpp:0066](init): Initializing board (Espressif:ESP32_S3_LCD_EV_BOARD_2_V1_5)
[I][Panel][esp_panel_board.cpp:0235](init): Board initialize success
[I][Panel][esp_panel_board.cpp:0253](begin): Beginning board (Espressif:ESP32_S3_LCD_EV_BOARD_2_V1_5)
[I][Panel][esp_lcd_touch_gt1151.c:0050](esp_lcd_touch_new_i2c_gt1151): version: 1.0.5
[I][Panel][esp_lcd_touch_gt1151.c:0234](read_product_id): IC version: GT1158_000101(Patch)_0102(Mask)_00(SensorID)
[I][Panel][esp_panel_board.cpp:0459](begin): Board begin success
Initializing LVGL
[I][LvPort][lvgl_v8_port.cpp:0769](lvgl_port_init): Initializing LVGL display driver
Creating UI
IDLE loop
IDLE loop
...

Troubleshooting

Please check the FAQ first to see if the same question exists. If not, please create a Github Issue. We will get back to you as soon as possible.