Merge branch 'feat/add_a_m5Stack_br_example' into 'main'

feat: add a border router example based on m5stack

See merge request espressif/esp-thread-br!164

Author: chshu

.gitlab-ci.yml

@@ -60,6 +60,19 @@ pre_commit:
   - cp ${CI_TOOLS_PATH}/basic_thread_border_router.cmake CMakeLists.txt
   - idf.py build
 
+.build_m5stack_thread_border_router: &build_m5stack_thread_border_router
+  - cd $IDF_PATH/examples/openthread/ot_rcp
+  - idf.py set-target esp32h2
+  - git rev-parse HEAD
+  - idf.py build
+  - cd $ESP_THREAD_BR_PATH/examples/m5stack_thread_border_router
+  - git fetch origin main
+  - python3 $ESP_THREAD_BR_PATH/example_build_version_check.py m5stack_thread_border_router esp_ot_cli_extension
+  - python3 $ESP_THREAD_BR_PATH/example_build_version_check.py m5stack_thread_border_router esp_rcp_update
+  - rm -rf CMakeLists.txt
+  - cp ${CI_TOOLS_PATH}/basic_thread_border_router.cmake CMakeLists.txt
+  - idf.py build
+
 .build_local_components: &build_local_components
   - cd $IDF_PATH/examples/openthread/ot_rcp
   - idf.py set-target esp32h2
@@ -120,6 +133,15 @@ build_examples:
     tags:
         - build
 
+build_examples_m5stack:
+    stage: build
+    image: espressif/idf:v5.4.1
+    script:
+        - *submodule_update
+        - *build_m5stack_thread_border_router
+    tags:
+        - build
+
 build_examples_local_components:
     stage: build
     image: $ESP_ENV_IMAGE

.pre-commit-config.yaml

@@ -6,6 +6,7 @@ repos:
     rev: 'v14.0.6'  # Use the sha / tag you want to point at
     hooks:
     - id: clang-format
+      exclude: "examples/common/thread_border_router_m5stack/image/.*"
 
   - repo: local
     hooks:

components/esp_ot_cli_extension/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.3.3"
+version: "1.3.4"
 description: Espressif OpenThread CLI Extension
 url: https://github.com/espressif/esp-thread-br/tree/main/components/esp_ot_cli_extension
 dependencies:

components/esp_ot_cli_extension/include/esp_ot_wifi_cmd.h

@@ -27,17 +27,17 @@ typedef enum {
 otError esp_ot_process_wifi_cmd(void *aContext, uint8_t aArgsLength, char *aArgs[]);
 
 /**
- * @brief This function set or clear the border router initalization flag.
+ * @brief This function sets or clears the border router initalization flag.
  *
  * @param[in]   initialized  border router is or not initalized.
  */
 void esp_ot_wifi_border_router_init_flag_set(bool initialized);
 
 /**
- * @brief This function connect the wifi.
+ * @brief This function connects to Wi-Fi.
  *
- * @param[in]   ssid        ssid of wifi
- * @param[in]   password    password of wifi
+ * @param[in]   ssid        ssid of Wi-Fi
+ * @param[in]   password    password of Wi-Fi
  *
  * @return
  *      - ESP_OK on success
@@ -46,7 +46,16 @@ void esp_ot_wifi_border_router_init_flag_set(bool initialized);
 esp_err_t esp_ot_wifi_connect(const char *ssid, const char *password);
 
 /**
- * @brief This function initalize the nvs for wifi configurations.
+ * @brief This function disconnects Wi-Fi.
+ *
+ * @return
+ *      - ESP_OK on success
+ *      - others on failure
+ */
+esp_err_t esp_ot_wifi_disconnect(void);
+
+/**
+ * @brief This function initializes the nvs for Wi-Fi configurations.
  *
  * @return
  *      - ESP_OK on success
@@ -55,9 +64,9 @@ esp_err_t esp_ot_wifi_connect(const char *ssid, const char *password);
 esp_err_t esp_ot_wifi_config_init(void);
 
 /**
- * @brief This function set the wifi ssid.
+ * @brief This function sets the Wi-Fi ssid.
  *
- * @param[in]   ssid    pointer to ssid of wifi
+ * @param[in]   ssid    pointer to ssid of Wi-Fi
  *
  * @return
  *      - ESP_OK on success
@@ -66,9 +75,9 @@ esp_err_t esp_ot_wifi_config_init(void);
 esp_err_t esp_ot_wifi_config_set_ssid(const char *ssid);
 
 /**
- * @brief This function get the wifi ssid.
+ * @brief This function gets the Wi-Fi ssid.
  *
- * @param[in]   password    pointer to password of wifi
+ * @param[in]   password    pointer to password of Wi-Fi
  *
  * @return
  *      - ESP_OK on success
@@ -77,9 +86,9 @@ esp_err_t esp_ot_wifi_config_set_ssid(const char *ssid);
 esp_err_t esp_ot_wifi_config_get_ssid(char *ssid);
 
 /**
- * @brief This function set the wifi password.
+ * @brief This function sets the Wi-Fi password.
  *
- * @param[in]   ssid    pointer to ssid of wifi
+ * @param[in]   ssid    pointer to ssid of Wi-Fi
  *
  * @return
  *      - ESP_OK on success
@@ -88,9 +97,9 @@ esp_err_t esp_ot_wifi_config_get_ssid(char *ssid);
 esp_err_t esp_ot_wifi_config_set_password(const char *password);
 
 /**
- * @brief This function get the wifi password.
+ * @brief This function gets the Wi-Fi password.
  *
- * @param[in]   password    pointer to password of wifi
+ * @param[in]   password    pointer to password of Wi-Fi
  *
  * @return
  *      - ESP_OK on success
@@ -99,14 +108,24 @@ esp_err_t esp_ot_wifi_config_set_password(const char *password);
 esp_err_t esp_ot_wifi_config_get_password(char *password);
 
 /**
- * @brief This function clear the wifi configurations stored in nvs.
+ * @brief This function clears the Wi-Fi configurations stored in nvs.
  *
  * @return
  *      - ESP_OK on success
  *      - others on failure
  */
 esp_err_t esp_ot_wifi_config_clear(void);
 
+/**
+ * @brief This function gets the Wi-Fi state.
+ *
+ * @return
+ *      OT_WIFI_DISCONNECTED if Wi-Fi is disconnected
+ *      OT_WIFI_CONNECTED if Wi-Fi is connected
+ *      OT_WIFI_RECONNECTING if Wi-Fi is reconnecting
+ */
+esp_ot_wifi_state_t esp_ot_wifi_state_get(void);
+
 #ifdef __cplusplus
 }
 #endif

components/esp_ot_cli_extension/src/esp_ot_wifi_cmd.c

@@ -420,4 +420,9 @@ esp_err_t esp_ot_wifi_config_clear(void)
     ESP_RETURN_ON_FALSE((s_wifi_config_nvs_handle != 0), ESP_FAIL, OT_EXT_CLI_TAG, "wifi_config NVS handle is invalid");
     ESP_RETURN_ON_ERROR(nvs_erase_all(s_wifi_config_nvs_handle), OT_EXT_CLI_TAG, "Fail to clear wifi configurations");
     return ESP_OK;
+}
+
+esp_ot_wifi_state_t esp_ot_wifi_state_get(void)
+{
+    return s_wifi_state;
 }

examples/basic_thread_border_router/main/esp_ot_br.c

@@ -89,7 +89,7 @@ void app_main(void)
     ESP_ERROR_CHECK(esp_event_loop_create_default());
 
 #if !CONFIG_OPENTHREAD_BR_AUTO_START && CONFIG_EXAMPLE_CONNECT_ETHERNET
-// TODO: Add a menchanism for connecting ETH manually.
+// TODO: Add a mechanism for connecting ETH manually.
 #error Currently we do not support a manual way to connect ETH, if you want to use ETH, please enable OPENTHREAD_BR_AUTO_START.
 #endif
 

examples/common/thread_border_router/Kconfig.projbuild

@@ -15,44 +15,57 @@ menu "ESP Thread Border Router Example"
             bool "Border router dev kit"
             help
                 Integrated border router dev kit
+
+        config ESP_BR_BOARD_M5STACK_CORES3
+            bool "Border router M5Stack CoreS3"
+            help
+                M5Stack CoreS3
     endchoice
 
     menu "Board Configuration"
         config PIN_TO_RCP_RESET
             int "Pin to RCP reset"
-            default "7"
+            default 7 if ESP_BR_BOARD_DEV_KIT
+            default 7 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_BOOT
             int "Pin to RCP boot"
-            default "8"
+            default 8 if ESP_BR_BOARD_DEV_KIT
+            default 18 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_TX
             int "Pin to RCP TX"
-            default "17"
+            default 17 if ESP_BR_BOARD_DEV_KIT
+            default 10 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_RX
             int "Pin to RCP RX"
-            default "18"
+            default 18 if ESP_BR_BOARD_DEV_KIT
+            default 17 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_CS
             depends on OPENTHREAD_RADIO_SPINEL_SPI
             int "Pin to RCP SPI CS"
-            default "10"
+            default 10 if ESP_BR_BOARD_DEV_KIT
+            default 13 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_SCLK
             depends on OPENTHREAD_RADIO_SPINEL_SPI
             int "Pin to RCP SPI SCLK"
-            default "12"
+            default 12 if ESP_BR_BOARD_DEV_KIT
+            default 36 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_MISO
             depends on OPENTHREAD_RADIO_SPINEL_SPI
             int "Pin to RCP SPI MISO"
-            default "13"
+            default 13 if ESP_BR_BOARD_DEV_KIT
+            default 35 if ESP_BR_BOARD_M5STACK_CORES3
 
         config PIN_TO_RCP_MOSI
             depends on OPENTHREAD_RADIO_SPINEL_SPI
             int "Pin to RCP SPI MOSI"
-            default "11"
+            default 11 if ESP_BR_BOARD_DEV_KIT
+            default 37 if ESP_BR_BOARD_M5STACK_CORES3
     endmenu
 
     choice ESP_BR_RCP_TARGET
@@ -100,22 +113,26 @@ menu "ESP Thread Border Router Example"
         config EXTERNAL_COEX_REQUEST_PIN
             int "The number of external coexist request pin"
             depends on ESP_COEX_EXTERNAL_COEXIST_ENABLE && (EXTERNAL_COEX_WIRE_TYPE >= 0)
-            default 12
+            default 12 if ESP_BR_BOARD_DEV_KIT
+            default 36 if ESP_BR_BOARD_M5STACK_CORES3
 
         config EXTERNAL_COEX_GRANT_PIN
             int "The number of external coexist grant pin"
             depends on ESP_COEX_EXTERNAL_COEXIST_ENABLE && (EXTERNAL_COEX_WIRE_TYPE >= 1)
-            default 13
+            default 13 if ESP_BR_BOARD_DEV_KIT
+            default 35 if ESP_BR_BOARD_M5STACK_CORES3
 
         config EXTERNAL_COEX_PRIORITY_PIN
             int "The number of external coexist priority pin"
             depends on ESP_COEX_EXTERNAL_COEXIST_ENABLE && (EXTERNAL_COEX_WIRE_TYPE >= 2)
-            default 10
+            default 10 if ESP_BR_BOARD_DEV_KIT
+            default 13 if ESP_BR_BOARD_M5STACK_CORES3
 
         config EXTERNAL_COEX_TX_LINE_PIN
             int "The number of external coexist tx_line pin"
             depends on ESP_COEX_EXTERNAL_COEXIST_ENABLE && (EXTERNAL_COEX_WIRE_TYPE = 3)
-            default 11
+            default 11 if ESP_BR_BOARD_DEV_KIT
+            default 37 if ESP_BR_BOARD_M5STACK_CORES3
     endmenu # External coexist wire type and pin config
 
 endmenu

examples/common/thread_border_router_m5stack/CMakeLists.txt

@@ -0,0 +1,13 @@
+set(requires esp_ot_cli_extension openthread protocol_examples_common vfs esp_wifi esp_eth esp_rcp_update m5stack_core_s3)
+
+if(CONFIG_OPENTHREAD_CLI_OTA)
+    list(APPEND requires esp_http_client esp_br_http_ota)
+endif()
+
+set(extra_include_dirs
+    $ENV{IDF_PATH}/components/openthread/private_include)
+
+idf_component_register(SRC_DIRS "src" "image"
+                       INCLUDE_DIRS "include" "private_include" "${extra_include_dirs}"
+                       REQUIRES "${requires}"
+)

examples/common/thread_border_router_m5stack/Kconfig.projbuild

@@ -0,0 +1,15 @@
+menu "ESP Thread Border Router M5Stack Example"
+
+    config OPENTHREAD_EPHEMERALKEY_LIFE_TIME
+        int "The life time (seconds) of openthread ephemeral key"
+        default 100
+        help
+            Set the lifetime of the OpenThread ephemeral key in seconds.
+
+    config OPENTHREAD_EPHEMERALKEY_PORT
+        int "The UDP port to use with the ephemeral key"
+        default 49180
+        help
+            Set the UDP port to use with the ephemeral key.
+
+endmenu