Merge branch 'docs/v1.0-beta' into 'main'

docs: update for 1.0-beta release

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

Author: chshu

.gitlab-ci.yml

@@ -43,7 +43,7 @@ pre_commit:
 
 .build_basic_thread_border_router: &build_basic_thread_border_router
   - cd $IDF_PATH/examples/openthread/ot_rcp
-  - idf.py --preview set-target esp32h2
+  - idf.py set-target esp32h2
   - git rev-parse HEAD
   - idf.py build
 
@@ -52,7 +52,7 @@ pre_commit:
 
 .build_local_components: &build_local_components
   - cd $IDF_PATH/examples/openthread/ot_rcp
-  - idf.py --preview set-target esp32h2
+  - idf.py set-target esp32h2
   - git rev-parse HEAD
   - idf.py build
 
@@ -70,7 +70,7 @@ pre_commit:
   - cp ${CI_TOOLS_PATH}/ot_br.cmake CMakeLists.txt
   - idf.py set-target esp32s3
   - idf.py build
-  - idf.py --preview set-target esp32c6
+  - idf.py set-target esp32c6
   - idf.py build
 
 .build_idf_example_ot_br_autostart: &build_idf_example_ot_br_autostart
@@ -84,7 +84,7 @@ pre_commit:
   - cp ${CI_TOOLS_PATH}/sdkconfig.br.autostart sdkconfig.defaults
   - idf.py set-target esp32s3
   - idf.py build
-  - idf.py --preview set-target esp32c6
+  - idf.py set-target esp32c6
   - idf.py build
 
 .build_idf_example_ot_cli: &build_idf_example_ot_cli
@@ -94,9 +94,9 @@ pre_commit:
   - cd ..
   - rm -rf CMakeLists.txt
   - cp ${CI_TOOLS_PATH}/ot_cli.cmake CMakeLists.txt
-  - idf.py --preview set-target esp32c6
+  - idf.py set-target esp32c6
   - idf.py build
-  - idf.py --preview set-target esp32h2
+  - idf.py set-target esp32h2
   - idf.py build
 
 build_examples:
@@ -149,7 +149,7 @@ build_idf_otcli_examples:
         - build
 
 build_docs:
-    stage: docs
+    stage: build
     image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-3
     variables:
         ESP_DOCS_LATEST_BRANCH_NAME: "main"

components/esp_ot_cli_extension/CMakeLists.txt

@@ -1,13 +1,11 @@
-set(srcs    src/esp_ot_cli_extension.c src/esp_ot_ip.c src/esp_ot_loglevel.c)
-
-if(CONFIG_OPENTHREAD_CLI_IPERF)
-    list(APPEND srcs   "src/esp_ot_iperf.c")
-endif()
-
-if(CONFIG_OPENTHREAD_CLI_SOCKET)
-    list(APPEND srcs    "src/esp_ot_tcp_socket.c"
-                        "src/esp_ot_udp_socket.c")
-endif()
+set(srcs    "src/esp_ot_cli_extension.c"
+            "src/esp_ot_curl.c"
+            "src/esp_ot_heap_diag.c"
+            "src/esp_ot_ip.c"
+            "src/esp_ot_iperf.c"
+            "src/esp_ot_loglevel.c"
+            "src/esp_ot_tcp_socket.c"
+            "src/esp_ot_udp_socket.c")
 
 if(CONFIG_OPENTHREAD_CLI_WIFI)
     list(APPEND srcs   "src/esp_ot_wifi_cmd.c")
@@ -21,14 +19,6 @@ if(CONFIG_OPENTHREAD_DNS64_CLIENT)
     list(APPEND srcs   "src/esp_ot_dns64.c")
 endif()
 
-if(CONFIG_OPENTHREAD_CLI_CURL)
-    list(APPEND srcs   "src/esp_ot_curl.c")
-endif()
-
-if(CONFIG_OPENTHREAD_CLI_HEAP_DIAG)
-    list(APPEND srcs   "src/esp_ot_heap_diag.c")
-endif()
-
 set(include "include")
 idf_component_register(SRCS "${srcs}"
                     INCLUDE_DIRS "${include}"

components/esp_ot_cli_extension/Kconfig

@@ -7,30 +7,6 @@ menu "OpenThread Extension CLI"
         help
             Enable Espressif's extended features.
 
-    config OPENTHREAD_CLI_IPERF
-        bool "Enable iperf command"
-        depends on OPENTHREAD_CLI_ESP_EXTENSION
-        default y
-
-    config OPENTHREAD_CLI_SOCKET
-        bool "Enable socket command"
-        depends on OPENTHREAD_CLI_ESP_EXTENSION
-        default y
-
-    config OPENTHREAD_CLI_TCP_SERVER_PORT
-        int "the port of TCP socket server"
-        default 12345
-        depends on OPENTHREAD_CLI_SOCKET
-        help
-            Set the connect port of socket
-
-    config OPENTHREAD_CLI_UDP_SERVER_PORT
-        int "the port of UDP server"
-        default 12346
-        depends on OPENTHREAD_CLI_SOCKET
-        help
-            Set the connect port of socket
-
     config OPENTHREAD_CLI_WIFI
         bool "Enable wifi connection command"
         depends on OPENTHREAD_CLI_ESP_EXTENSION && OPENTHREAD_BORDER_ROUTER
@@ -41,14 +17,4 @@ menu "OpenThread Extension CLI"
         depends on OPENTHREAD_CLI_ESP_EXTENSION && OPENTHREAD_BORDER_ROUTER
         default n
 
-    config OPENTHREAD_CLI_CURL
-        bool "Enable curl command"
-        depends on OPENTHREAD_CLI_ESP_EXTENSION
-        default y
-
-    config OPENTHREAD_CLI_HEAP_DIAG
-        bool "Enable heapdiag command"
-        depends on OPENTHREAD_CLI_ESP_EXTENSION
-        default y
-
 endmenu

components/esp_ot_cli_extension/README.md

@@ -9,18 +9,76 @@ To enable OpenThread extension commands, the following Kconfig option needs to b
 
 ## Commands
 
+* [curl](#curl)
+* [dns64server](#dns64server)
+* [heapdiag](#heapdiag)
 * [ip](#ip)
 * [iperf](#iperf)
+* [loglevel](#loglevel)
+* [mcast](#mcast)
+* [ota](#ota)
 * [tcpsockclient](#tcpsockclient)
 * [tcpsockserver](#tcpsockserver)
 * [udpsockclient](#udpsockclient)
 * [udpsockserver](#udpsockserver)
 * [wifi](#wifi)
-* [ota](#ota)
-* [dns64server](#dns64server)
-* [curl](#curl)
-* [heapdiag](#heapdiag)
-* [loglevel](#loglevel)
+
+
+### curl
+
+Used for fetching the content of a HTTP web page. Note that the border router must support NAT64.
+
+```
+> curl http://www.espressif.com
+Done
+<html>
+<head><title>301 Moved Permanently</title></head>
+<body bgcolor="white">
+<center><h1>301 Moved Permanently</h1></center>
+<hr><center>CloudFront</center>
+</body>
+</html>
+```
+
+### dns64server
+
+Used for setting the dns64 server. Note that the border router must support NAT64.
+
+```
+> dns64server 8.8.8.8
+```
+
+### heapdiag
+
+Used for heap diagnostics.
+
+To get the current heap usage:
+
+```
+> heapdiag print
+        Description     Internal        SPIRAM
+Current Free Memory     246680          0
+Largest Free Block      180224          0
+Min. Ever Free Size     246072          0
+Done
+```
+To reset the heap trace baseline if the menuconfig option `HEAP_TRACING_STANDALONE` is selected:
+
+```
+> heapdiag tracereset
+```
+
+To dump the heap trace record if the menuconfig option `HEAP_TRACING_STANDALONE` is selected:
+
+```
+> heapdiag tracedump
+```
+
+To dump heap usage of each task of the menuconfig option `HEAP_TASK_TRACKING` is selected:
+
+```
+> heapdiag tracetask
+```
 
 ### ip
 
@@ -128,6 +186,55 @@ Then create an iperf client:
 Done
 ```
 
+### loglevel
+
+Used for setting the log level for various log tags.
+
+To set log level of all the tags to INFO:
+
+```
+> loglevel set * 3
+```
+
+To set log level of OpenThread to None:
+
+```
+> loglevel set OPENTHREAD 0
+```
+
+Notes:
+- Support 6 levels : 0(NONE), 1(ERROR), 2(WARN), 3(INFO), 4(DEBUG), 5(VERBOSE)
+- The log level of the tags cannot be bigger than the maximum log level. The maximum log level is determined by the menuconfig option `LOG_MAXIMUM_LEVEL`.
+
+### mcast
+
+Use this command to join or leave a multicast group.
+
+```bash
+> mcast join ff04::123
+
+Done
+> mcast leave ff04::123
+
+Done
+```
+
+### ota
+
+Used for downloading border router firmware and updating the border router or the RCP alone.
+
+```
+> ota download https://192.168.1.2:8070/br_ota_image
+```
+
+After downloading the device will restart and update itself with the new firmware. The RCP will also be updated if the firmware version changes.
+
+```
+> ota rcpudate
+```
+
+This command will enforce a RCP update regardless of the RCP version.
+
 ### tcpsockserver
 
 Used for creating a tcp server.
@@ -472,102 +579,3 @@ connected
 Done
 ```
 
-### ota
-
-Used for downloading border router firmware and updating the border router or the RCP alone.
-
-```
-> ota download https://192.168.1.2:8070/br_ota_image
-```
-
-After downloading the device will restart and update itself with the new firmware. The RCP will also be updated if the firmware version changes.
-
-```
-> ota rcpudate
-```
-
-This command will enforce a RCP update regardless of the RCP version.
-
-### dns64server
-
-Used for setting the dns64 server. Note that the border router must support NAT64.
-
-```
-> dns64server 8.8.8.8
-```
-
-### curl
-
-Used for fetching the content of a HTTP web page. Note that the border router must support NAT64.
-
-```
-> curl http://www.espressif.com
-Done
-<html>
-<head><title>301 Moved Permanently</title></head>
-<body bgcolor="white">
-<center><h1>301 Moved Permanently</h1></center>
-<hr><center>CloudFront</center>
-</body>
-</html>
-```
-
-### heapdiag
-
-Used for heap diagnostics.
-
-To get the current heap usage:
-
-```
-> heapdiag print
-        Description     Internal        SPIRAM
-Current Free Memory     246680          0
-Largest Free Block      180224          0
-Min. Ever Free Size     246072          0
-Done
-```
-
-To start or stop the daemon task that prints the heap usage periodically:
-
-```
-heapdiag daemon on <period_ms>
-heapdiag daemon off
-```
-
-To reset the heap trace baseline if the menuconfig option `HEAP_TRACING_STANDALONE` is selected:
-
-```
-> heapdiag tracereset
-```
-
-To dump the heap trace record if the menuconfig option `HEAP_TRACING_STANDALONE` is selected:
-
-```
-> heapdiag tracedump
-```
-
-To dump heap usage of each task of the menuconfig option `HEAP_TASK_TRACKING` is selected:
-
-```
-> heapdiag tracetask
-```
-
-### loglevel
-
-Used for setting the log level for various log tag
-
-To set log level of all the tags to INFO
-
-```
-> loglevel set * 3
-```
-
-To set log level of OpenThread to None
-
-```
-> loglevel set OPENTHREAD 0
-```
-
-Notes:
-- Support 6 levels : 0(NONE), 1(ERROR), 2(WARN), 3(INFO), 4(DEBUG), 5(VERBOSE)
-- The log level of the tags cannot be bigger than the maximum log level. The maximum log level is determined by the menuconfig option `LOG_MAXIMUM_LEVEL`.

components/esp_ot_cli_extension/idf_component.yml

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