From 2ff396ee5e4f8bfa0cfe33d05e2908c1e2ea8308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludovic=20BOU=C3=89?= Date: Fri, 17 May 2024 08:04:31 +0200 Subject: [PATCH] fix(docs): fix broken links in 'Panel Test Example' README Closes https://github.com/esp-arduino-libs/ESP32_Display_Panel/pull/27 --- CHANGELOG.md | 6 ++++++ ESP_Panel_Board_Custom.h | 2 ++ examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h | 2 ++ examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h | 2 ++ examples/Panel/PanelTest/ESP_Panel_Board_Custom.h | 2 ++ examples/Panel/PanelTest/README.md | 6 +++--- examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h | 2 ++ examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h | 2 ++ library.properties | 2 +- 9 files changed, 22 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e0766db1..4586a279 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # ChangeLog +## v0.1.2 - 2024-05-17 + +### Bugfixes: + +* fix(docs): fix broken links in 'Panel Test Example' README by @lboue (#27) + ## v0.1.1 - 2024-05-16 ### Enhancements: diff --git a/ESP_Panel_Board_Custom.h b/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/ESP_Panel_Board_Custom.h +++ b/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h +++ b/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h +++ b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h b/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h +++ b/examples/Panel/PanelTest/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/examples/Panel/PanelTest/README.md b/examples/Panel/PanelTest/README.md index eff24a10..1468dfc9 100644 --- a/examples/Panel/PanelTest/README.md +++ b/examples/Panel/PanelTest/README.md @@ -7,9 +7,9 @@ The example demonstrates how to develop built-in or custom development boards us Follow the steps below to configure: 1. [Configure drivers](../../../README.md#configuring-drivers) if needed. -2. If using a supported development board, follow the [steps](../../../../README.md#using-supported-development-boards) to configure it. -3. If using a custom board, follow the [steps](../../../../README.md#using-custom-development-boards) to configure it. -4. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](../../../../README.md#configuring-supported-development-boards) +2. If using a supported development board, follow the [steps](../../../README.md#using-supported-development-boards) to configure it. +3. If using a custom board, follow the [steps](../../../README.md#using-custom-development-boards) to configure it. +4. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](../../../README.md#configuring-supported-development-boards) 5. Verify and upload the example to your ESP board. ## Serial Output diff --git a/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h b/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h +++ b/examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h b/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h index ec5ac671..8ca14043 100644 --- a/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h +++ b/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Custom.h @@ -39,6 +39,8 @@ /** * If set to 1, the bus will skip to initialize the corresponding host. Users need to initialize the host in advance. * It is useful if other devices use the same host. Please ensure that the host is initialized only once. + * + * Set to 1 if only the RGB interface is used without the 3-wire SPI interface, */ #define ESP_PANEL_LCD_BUS_SKIP_INIT_HOST (0) // 0/1 /** diff --git a/library.properties b/library.properties index 43afb8b7..68a7f205 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ESP32_Display_Panel -version=0.1.1 +version=0.1.2 author=espressif maintainer=espressif sentence=ESP32_Display_Panel is an Arduino library designed for ESP SoCs to drive display panels and facilitate rapid GUI development.