feat(repo): support MicroPython

Lzw655 · Lzw655 · commit 25694781b5cb · 2024-12-13T16:32:54.000+08:00
diff --git a/esp_panel_board_custom.h b/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/LVGL/v8/Porting/esp_panel_board_custom.h b/examples/LVGL/v8/Porting/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/LVGL/v8/Rotation/esp_panel_board_custom.h b/examples/LVGL/v8/Rotation/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/Panel/PanelTest/esp_panel_board_custom.h b/examples/Panel/PanelTest/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/PlatformIO/src/esp_panel_board_custom.h b/examples/PlatformIO/src/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/SquareLine/v8/Porting/esp_panel_board_custom.h b/examples/SquareLine/v8/Porting/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/examples/SquareLine/v8/WiFiClock/esp_panel_board_custom.h b/examples/SquareLine/v8/WiFiClock/esp_panel_board_custom.h
@@ -9,7 +9,7 @@
 // *INDENT-OFF*
 
 /* Set to 1 if using a custom board */
-#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (1)     // 0/1
+#define ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM  (0)     // 0/1
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM
 
diff --git a/micropython.cmake b/micropython.cmake
@@ -0,0 +1,25 @@
+# This file is to be given as "make USER_C_MODULES=..." when building Micropython port
+
+add_library(usermod_esp_display_panel INTERFACE)
+
+# Find all source files in the `src` directory.
+set(SRC_DIR ${CMAKE_CURRENT_LIST_DIR}/src)
+file(GLOB_RECURSE SRCS_C ${SRC_DIR}/*.c)
+file(GLOB_RECURSE SRCS_CXX ${SRC_DIR}/*.cpp)
+
+# Find all source files in the `micropython` directory.
+set(MPY_DIR ${CMAKE_CURRENT_LIST_DIR}/mpy_support)
+file(GLOB_RECURSE MPY_C ${MPY_DIR}/*.c)
+file(GLOB_RECURSE MPY_CXX ${MPY_DIR}/*.cpp)
+
+# Add source files to the library.
+target_sources(usermod_esp_display_panel INTERFACE ${SRCS_C} ${SRCS_CXX} ${MPY_C} ${MPY_CXX})
+
+# Add the current directory as an include directory.
+target_include_directories(usermod_esp_display_panel INTERFACE ${SRC_DIR} ${MPY_DIR})
+
+# Add compile options. Since the target is not created by `idf_component_register()`, we need to add the `ESP_PLATFORM` define manually.
+target_compile_options(usermod_esp_display_panel INTERFACE -Wno-missing-field-initializers -DESP_PLATFORM)
+
+# Link INTERFACE library to the usermod target.
+target_link_libraries(usermod INTERFACE usermod_esp_display_panel)
diff --git a/mpy_support/esp_panel_mp_board.cpp b/mpy_support/esp_panel_mp_board.cpp
@@ -0,0 +1,100 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include "esp_panel_utils.h"
+#include "board/esp_panel_board.hpp"
+#include "esp_panel_mp_types.h"
+#include "esp_panel_mp_board.h"
+
+namespace esp_panel {
+
+/**
+ * MicroPython Wrappers
+ *
+ */
+// Object
+struct MP_Board {
+    mp_obj_base_t base;
+    std::shared_ptr<Board> board = nullptr;
+};
+
+static mp_obj_t board_del(mp_obj_t self_in)
+{
+    MP_Board *self = static_cast<MP_Board *>(MP_OBJ_TO_PTR(self_in));
+
+    self->board = nullptr;
+
+    return mp_const_none;
+}
+static MP_DEFINE_CONST_FUN_OBJ_1_CXX(board_del_func_obj, board_del);
+
+static mp_obj_t board_init(mp_obj_t self_in)
+{
+    MP_Board *self = static_cast<MP_Board *>(MP_OBJ_TO_PTR(self_in));
+
+    return mp_obj_new_bool(self->board->init());
+}
+static MP_DEFINE_CONST_FUN_OBJ_1_CXX(board_init_func_obj, board_init);
+
+static mp_obj_t board_begin(mp_obj_t self_in)
+{
+    MP_Board *self = static_cast<MP_Board *>(MP_OBJ_TO_PTR(self_in));
+
+    return mp_obj_new_bool(self->board->begin());
+}
+static MP_DEFINE_CONST_FUN_OBJ_1_CXX(board_begin_func_obj, board_begin);
+
+static mp_obj_t board_deinit(mp_obj_t self_in)
+{
+    MP_Board *self = static_cast<MP_Board *>(MP_OBJ_TO_PTR(self_in));
+
+    return mp_obj_new_bool(self->board->del());
+}
+static MP_DEFINE_CONST_FUN_OBJ_1_CXX(board_deinit_func_obj, board_deinit);
+
+static mp_obj_t board_color_bar_test(mp_obj_t self_in)
+{
+    MP_Board *self = static_cast<MP_Board *>(MP_OBJ_TO_PTR(self_in));
+
+    return mp_obj_new_bool(self->board->getLcd()->colorBarTest(480, 480));
+}
+static MP_DEFINE_CONST_FUN_OBJ_1_CXX(board_color_bar_test_func_obj, board_color_bar_test);
+
+// Local dict
+static const mp_rom_map_elem_t board_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR__del__), MP_ROM_PTR(&board_del_func_obj) },
+    { MP_ROM_QSTR(MP_QSTR_init), MP_ROM_PTR(&board_init_func_obj) },
+    { MP_ROM_QSTR(MP_QSTR_begin), MP_ROM_PTR(&board_begin_func_obj) },
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&board_deinit_func_obj) },
+    { MP_ROM_QSTR(MP_QSTR_color_bar_test), MP_ROM_PTR(&board_color_bar_test_func_obj) },
+};
+static MP_DEFINE_CONST_DICT(board_locals_dict, board_locals_dict_table);
+
+// Constructor
+static mp_obj_t board_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args)
+{
+    MP_Board *self = mp_obj_malloc(MP_Board, &MP_Boardype);
+    self->board = esp_utils::make_shared<Board>();
+
+    return MP_OBJ_FROM_PTR(self);
+}
+
+// Print
+static void board_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind)
+{
+    mp_printf(print, "Board");
+}
+
+} // namespace esp_panel
+
+// Type
+MP_DEFINE_CONST_OBJ_TYPE(
+    MP_Boardype,
+    MP_QSTR_Board,
+    MP_TYPE_FLAG_NONE,
+    make_new, (const void *)esp_panel::board_make_new,
+    print, (const void *)esp_panel::board_print,
+    locals_dict, &esp_panel::board_locals_dict
+);
diff --git a/mpy_support/esp_panel_mp_board.h b/mpy_support/esp_panel_mp_board.h
@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "py/runtime.h"
+#include "py/obj.h"
+
+extern const mp_obj_type_t esp_panel_mp_board_type;
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/mpy_support/esp_panel_mp_module.c b/mpy_support/esp_panel_mp_module.c
@@ -0,0 +1,27 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include "py/runtime.h"
+#include "esp_panel_mp_board.h"
+
+// Define all attributes of the module.
+// Table entries are key/value pairs of the attribute name (a string)
+// and the MicroPython object reference.
+// All identifiers and strings are written as MP_QSTR_xxx and will be
+// optimized to word-sized integers by the build system (interned strings).
+static const mp_rom_map_elem_t module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_esp_panel) },
+    { MP_ROM_QSTR(MP_QSTR_Board), MP_ROM_PTR(&esp_panel_mp_board_type) },
+};
+static MP_DEFINE_CONST_DICT(module_globals, module_globals_table);
+
+// Define module object.
+const mp_obj_module_t esp_panel_mp_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *) &module_globals,
+};
+
+// Register the module to make it available in Python.
+MP_REGISTER_MODULE(MP_QSTR_esp_panel, esp_panel_mp_module);
diff --git a/mpy_support/esp_panel_mp_types.h b/mpy_support/esp_panel_mp_types.h
@@ -0,0 +1,22 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "py/obj.h"
+
+#define MP_DEFINE_CONST_FUN_OBJ_1_CXX(obj_name, fun_name) \
+    const mp_obj_fun_builtin_fixed_t obj_name = { .base = &mp_type_fun_builtin_1, .fun = {._1 = fun_name }}
+
+#define MP_DEFINE_CONST_FUN_OBJ_2_CXX(obj_name, fun_name) \
+    const mp_obj_fun_builtin_fixed_t obj_name = { .base = &mp_type_fun_builtin_2, .fun = {._2 = fun_name }}
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/src/board/esp_panel_board.cpp b/src/board/esp_panel_board.cpp
@@ -24,7 +24,7 @@ Board::Board():
     _flags.use_default_config = 1;
 #if ESP_PANEL_BOARD_BACKLIGHT_TYPE == ESP_PANEL_BACKLIGHT_TYPE_CUSTOM
     using BacklightConfig = drivers::BacklightCustom::Config;
-    BacklightConfig &config = std::get<BacklightConfig>(_config.backlight.variant_config);
+    BacklightConfig &config = std::get<BacklightConfig>(_config.backlight.config);
     config.user_data = this;
 #endif // ESP_PANEL_BOARD_BACKLIGHT_TYPE
 }
diff --git a/src/drivers/backlight/esp_panel_backlight_base.hpp b/src/drivers/backlight/esp_panel_backlight_base.hpp
@@ -22,7 +22,7 @@ class Backlight {
      *
      */
     struct Attributes {
-        std::string name = "Unknown"; /*<! The backlight device name. Default is `"Unknown"` */
+        const char *name = nullptr;     /*<! The backlight device name. Default is `nullptr` */
     };
 
     /**
diff --git a/src/drivers/bus/esp_panel_bus_base.hpp b/src/drivers/bus/esp_panel_bus_base.hpp
@@ -25,7 +25,7 @@ class Bus {
      */
     struct Attributes {
         int type = -1;                  /*<! The bus type. Default is `-1` */
-        std::string name = "Unknown";   /*<! The bus name. Default is `"Unknown"` */
+        const char *name = nullptr;     /*<! The bus name. Default is `nullptr` */
     };
 
     /**
diff --git a/src/drivers/lcd/esp_panel_lcd.cpp b/src/drivers/lcd/esp_panel_lcd.cpp
@@ -14,11 +14,13 @@ namespace esp_panel::drivers {
     {LCD_Factory::Conrtoller::controller, LCD_ ##controller::ATTRIBUTES_DEFAULT.name}
 #define CASE_CONTROLLER(controller) \
     case Conrtoller::controller: \
+    { \
         ESP_UTILS_CHECK_EXCEPTION_RETURN( \
             (device = esp_utils::make_shared<LCD_ ## controller>(bus, config)), nullptr, "Create %s failed", \
             getControllerNameString(controller).c_str() \
         ); \
-        break
+        break; \
+    } \
 
 const std::map<LCD_Factory::Conrtoller, std::string> LCD_Factory::_controller_name_map = {
     ITEM_CONTROLLER(AXS15231B),
diff --git a/src/drivers/lcd/esp_panel_lcd_base.hpp b/src/drivers/lcd/esp_panel_lcd_base.hpp
@@ -92,7 +92,7 @@ class LCD {
         bool disable_display_on_off = 0;
         uint8_t x_coord_align = 1;
         uint8_t y_coord_align = 1;
-        std::string name = "Unknown";
+        const char *name = nullptr;
     };
 
     struct State {
diff --git a/src/drivers/touch/esp_panel_touch_base.cpp b/src/drivers/touch/esp_panel_touch_base.cpp
@@ -53,9 +53,9 @@ bool Touch::del(void)
     ESP_UTILS_LOG_TRACE_ENTER_WITH_THIS();
 
     if (checkIsBegun()) {
-        ESP_UTILS_CHECK_ERROR_RETURN(
-            esp_lcd_touch_del(touch_handle), false, "Delete touch panel(@%p) failed", touch_handle
-        );
+        // ESP_UTILS_CHECK_ERROR_RETURN(
+        //     esp_lcd_touch_del(touch_handle), false, "Delete touch panel(@%p) failed", touch_handle
+        // );
         ESP_UTILS_LOGD("Touch panel(@%p) deleted", touch_handle);
         touch_handle = nullptr;
     }
diff --git a/src/drivers/touch/esp_panel_touch_base.hpp b/src/drivers/touch/esp_panel_touch_base.hpp
@@ -87,7 +87,7 @@ class Touch {
     };
 
     struct Attributes {
-        std::string name = "Unknown";
+        const char *name = nullptr;
     };
 
     struct State {
diff --git a/src/drivers/touch/port/esp_lcd_touch_ft5x06.c b/src/drivers/touch/port/esp_lcd_touch_ft5x06.c
@@ -109,7 +109,8 @@ esp_err_t esp_lcd_touch_new_i2c_ft5x06(const esp_lcd_panel_io_handle_t io, const
     assert(out_touch != NULL);
 
     /* Prepare main structure */
-    esp_lcd_touch_handle_t esp_lcd_touch_ft5x06 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT);
+    // Use `calloc` instead of `heap_caps_calloc` for MicroPython compatibility
+    esp_lcd_touch_handle_t esp_lcd_touch_ft5x06 = calloc(1, sizeof(esp_lcd_touch_t));
     ESP_GOTO_ON_FALSE(esp_lcd_touch_ft5x06, ESP_ERR_NO_MEM, err, TAG, "no mem for FT5x06 controller");
 
     /* Communication interface */
diff --git a/src/drivers/touch/port/esp_lcd_touch_gt911.c b/src/drivers/touch/port/esp_lcd_touch_gt911.c
@@ -71,7 +71,8 @@ esp_err_t esp_lcd_touch_new_i2c_gt911(const esp_lcd_panel_io_handle_t io, const
     assert(out_touch != NULL);
 
     /* Prepare main structure */
-    esp_lcd_touch_handle_t esp_lcd_touch_gt911 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT);
+    // Use `calloc` instead of `heap_caps_calloc` for MicroPython compatibility
+    esp_lcd_touch_handle_t esp_lcd_touch_gt911 = calloc(1, sizeof(esp_lcd_touch_t));
     ESP_GOTO_ON_FALSE(esp_lcd_touch_gt911, ESP_ERR_NO_MEM, err, TAG, "no mem for GT911 controller");
 
     /* Communication interface */
diff --git a/src/drivers/touch/port/esp_lcd_touch_stmpe610.c b/src/drivers/touch/port/esp_lcd_touch_stmpe610.c
@@ -99,7 +99,8 @@ esp_err_t esp_lcd_touch_new_spi_stmpe610(const esp_lcd_panel_io_handle_t io, con
     assert(out_touch != NULL);
 
     /* Prepare main structure */
-    esp_lcd_touch_handle_t esp_lcd_touch_stmpe610 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT);
+    // Use `calloc` instead of `heap_caps_calloc` for MicroPython compatibility
+    esp_lcd_touch_handle_t esp_lcd_touch_stmpe610 = calloc(1, sizeof(esp_lcd_touch_t));
     ESP_GOTO_ON_FALSE(esp_lcd_touch_stmpe610, ESP_ERR_NO_MEM, err, TAG, "no mem for STMPE610 controller");
 
     /* Communication interface */
diff --git a/src/drivers/touch/port/esp_lcd_touch_tt21100.c b/src/drivers/touch/port/esp_lcd_touch_tt21100.c
@@ -60,7 +60,8 @@ esp_err_t esp_lcd_touch_new_i2c_tt21100(const esp_lcd_panel_io_handle_t io, cons
     assert(out_touch != NULL);
 
     /* Prepare main structure */
-    esp_lcd_touch_handle_t esp_lcd_touch_tt21100 = heap_caps_calloc(1, sizeof(esp_lcd_touch_t), MALLOC_CAP_DEFAULT);
+    // Use `calloc` instead of `heap_caps_calloc` for MicroPython compatibility
+    esp_lcd_touch_handle_t esp_lcd_touch_tt21100 = calloc(1, sizeof(esp_lcd_touch_t));
     ESP_GOTO_ON_FALSE(esp_lcd_touch_tt21100, ESP_ERR_NO_MEM, err, TAG, "no mem for TT21100 controller");
 
     /* Communication interface */
diff --git a/test_apps/common/main/test_common.cpp b/test_apps/common/main/test_common.cpp

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ Board::Board():`
`24`	`24`	`_flags.use_default_config = 1;`
`25`	`25`	`#if ESP_PANEL_BOARD_BACKLIGHT_TYPE == ESP_PANEL_BACKLIGHT_TYPE_CUSTOM`
`26`	`26`	`using BacklightConfig = drivers::BacklightCustom::Config;`
`27`		`- BacklightConfig &config = std::get<BacklightConfig>(_config.backlight.variant_config);`
	`27`	`+ BacklightConfig &config = std::get<BacklightConfig>(_config.backlight.config);`
`28`	`28`	`config.user_data = this;`
`29`	`29`	`#endif // ESP_PANEL_BOARD_BACKLIGHT_TYPE`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class Backlight {`
`22`	`22`	`*`
`23`	`23`	`*/`
`24`	`24`	`struct Attributes {`
`25`		- std::string name = "Unknown"; /<! The backlight device name. Default is `"Unknown"` /
	`25`	+ const char name = nullptr; /<! The backlight device name. Default is `nullptr` */
`26`	`26`	`};`
`27`	`27`
`28`	`28`	`/**`