Skip to content

Commit 82ad522

Browse files
Lzw655Lzw655
committed
feat(config): add version control for all configuration files by @Lzw655 (#32)
1 parent c653441 commit 82ad522

33 files changed

+721
-176
lines changed

‎CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# ChangeLog
22

3+
## v0.1.3 - 2024-05-26
4+
5+
### Enhancements:
6+
7+
* feat(config): add version control for all configuration files by @lzw655 (#32)
8+
39
## v0.1.2 - 2024-05-17
410

511
### Bugfixes:

‎ESP_Panel_Board_Custom.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,21 @@
349349
// #define ESP_PANEL_BEGIN_BACKLIGHT_END_FUNCTION( panel )
350350
// #define ESP_PANEL_BEGIN_END_FUNCTION( panel )
351351

352+
/**
353+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
354+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
355+
*
356+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
357+
* and must be replaced with the file from the library.
358+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
359+
* default values. It is recommended to replace it with the file from the library.
360+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
361+
*
362+
*/
363+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
364+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
365+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
366+
352367
#endif /* ESP_PANEL_USE_CUSTOM_BOARD */
353368

354369
// *INDENT-OFF*

‎ESP_Panel_Board_Supported.h

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#if ESP_PANEL_USE_SUPPORTED_BOARD
1313
/**
1414
* Uncomment one of the following macros to select an supported development board. If multiple macros are uncommented
15-
* simultaneously, only the first one will take effect.
15+
* at the same time, an error will be prompted during compilation.
1616
*
1717
*/
1818

@@ -56,4 +56,19 @@
5656
*/
5757
// #define BOARD_ESP32_4848S040C_I_Y_3
5858

59+
/**
60+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
61+
* the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
62+
*
63+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
64+
* and must be replaced with the file from the library.
65+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
66+
* default values. It is recommended to replace it with the file from the library.
67+
* 3. If the patch version is not consistent, it will not affect normal functionality.
68+
*
69+
*/
70+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
71+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
72+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
73+
5974
#endif

‎ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LCD/3wireSPI_RGB/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LCD/QSPI/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LCD/RGB/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LCD/SPI/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,21 @@
349349
// #define ESP_PANEL_BEGIN_BACKLIGHT_END_FUNCTION( panel )
350350
// #define ESP_PANEL_BEGIN_END_FUNCTION( panel )
351351

352+
/**
353+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
354+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
355+
*
356+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
357+
* and must be replaced with the file from the library.
358+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
359+
* default values. It is recommended to replace it with the file from the library.
360+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
361+
*
362+
*/
363+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
364+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
365+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
366+
352367
#endif /* ESP_PANEL_USE_CUSTOM_BOARD */
353368

354369
// *INDENT-OFF*

‎examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#if ESP_PANEL_USE_SUPPORTED_BOARD
1313
/**
1414
* Uncomment one of the following macros to select an supported development board. If multiple macros are uncommented
15-
* simultaneously, only the first one will take effect.
15+
* at the same time, an error will be prompted during compilation.
1616
*
1717
*/
1818

@@ -56,4 +56,19 @@
5656
*/
5757
// #define BOARD_ESP32_4848S040C_I_Y_3
5858

59+
/**
60+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
61+
* the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
62+
*
63+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
64+
* and must be replaced with the file from the library.
65+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
66+
* default values. It is recommended to replace it with the file from the library.
67+
* 3. If the patch version is not consistent, it will not affect normal functionality.
68+
*
69+
*/
70+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
71+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
72+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
73+
5974
#endif

‎examples/LVGL/v8/Porting/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,21 @@
349349
// #define ESP_PANEL_BEGIN_BACKLIGHT_END_FUNCTION( panel )
350350
// #define ESP_PANEL_BEGIN_END_FUNCTION( panel )
351351

352+
/**
353+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
354+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
355+
*
356+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
357+
* and must be replaced with the file from the library.
358+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
359+
* default values. It is recommended to replace it with the file from the library.
360+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
361+
*
362+
*/
363+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
364+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
365+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
366+
352367
#endif /* ESP_PANEL_USE_CUSTOM_BOARD */
353368

354369
// *INDENT-OFF*

‎examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#if ESP_PANEL_USE_SUPPORTED_BOARD
1313
/**
1414
* Uncomment one of the following macros to select an supported development board. If multiple macros are uncommented
15-
* simultaneously, only the first one will take effect.
15+
* at the same time, an error will be prompted during compilation.
1616
*
1717
*/
1818

@@ -56,4 +56,19 @@
5656
*/
5757
// #define BOARD_ESP32_4848S040C_I_Y_3
5858

59+
/**
60+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
61+
* the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
62+
*
63+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
64+
* and must be replaced with the file from the library.
65+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
66+
* default values. It is recommended to replace it with the file from the library.
67+
* 3. If the patch version is not consistent, it will not affect normal functionality.
68+
*
69+
*/
70+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
71+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
72+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
73+
5974
#endif

‎examples/LVGL/v8/Rotation/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/Panel/PanelTest/ESP_Panel_Board_Custom.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,21 @@
349349
// #define ESP_PANEL_BEGIN_BACKLIGHT_END_FUNCTION( panel )
350350
// #define ESP_PANEL_BEGIN_END_FUNCTION( panel )
351351

352+
/**
353+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
354+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
355+
*
356+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
357+
* and must be replaced with the file from the library.
358+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
359+
* default values. It is recommended to replace it with the file from the library.
360+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
361+
*
362+
*/
363+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
364+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
365+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
366+
352367
#endif /* ESP_PANEL_USE_CUSTOM_BOARD */
353368

354369
// *INDENT-OFF*

‎examples/Panel/PanelTest/ESP_Panel_Board_Supported.h

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#if ESP_PANEL_USE_SUPPORTED_BOARD
1313
/**
1414
* Uncomment one of the following macros to select an supported development board. If multiple macros are uncommented
15-
* simultaneously, only the first one will take effect.
15+
* at the same time, an error will be prompted during compilation.
1616
*
1717
*/
1818

@@ -56,4 +56,19 @@
5656
*/
5757
// #define BOARD_ESP32_4848S040C_I_Y_3
5858

59+
/**
60+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
61+
* the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
62+
*
63+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
64+
* and must be replaced with the file from the library.
65+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
66+
* default values. It is recommended to replace it with the file from the library.
67+
* 3. If the patch version is not consistent, it will not affect normal functionality.
68+
*
69+
*/
70+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
71+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
72+
#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
73+
5974
#endif

‎examples/Panel/PanelTest/ESP_Panel_Conf.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,18 @@
5858
*
5959
*/
6060
#define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING (0) // 0/1
61+
62+
/**
63+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
64+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
65+
*
66+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
67+
* and must be replaced with the file from the library.
68+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
69+
* default values. It is recommended to replace it with the file from the library.
70+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
71+
*
72+
*/
73+
#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
74+
#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
75+
#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0

‎examples/SquareLine/v8/Porting/ESP_Panel_Board_Custom.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,21 @@
349349
// #define ESP_PANEL_BEGIN_BACKLIGHT_END_FUNCTION( panel )
350350
// #define ESP_PANEL_BEGIN_END_FUNCTION( panel )
351351

352+
/**
353+
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
354+
* the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
355+
*
356+
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
357+
* and must be replaced with the file from the library.
358+
* 2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
359+
* default values. It is recommended to replace it with the file from the library.
360+
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
361+
*
362+
*/
363+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
364+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
365+
#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
366+
352367
#endif /* ESP_PANEL_USE_CUSTOM_BOARD */
353368

354369
// *INDENT-OFF*

0 commit comments

Comments
 (0)