diff --git a/docs/en/api-guides/tools/idf-monitor.rst b/docs/en/api-guides/tools/idf-monitor.rst index 012853fdf9..11f967dd36 100644 --- a/docs/en/api-guides/tools/idf-monitor.rst +++ b/docs/en/api-guides/tools/idf-monitor.rst @@ -129,7 +129,7 @@ For example, ``PRINT_FILTER="tag1:W"`` matches and prints only the outputs writt recompiling the application. Your app tags must not contain spaces, asterisks ``*``, -and semicolons ``:`` to be compatible with the output filtering feature. +or colons ``:`` to be compatible with the output filtering feature. If the last line of the output in your app is not followed by a carriage return, the output filtering might get confused, i.e., the monitor starts to print the line and later finds out that the line should not have been written. This is a known issue and can be avoided by always adding a carriage return (especially when no output follows immediately afterwards). diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index b36e673318..4d9f4eb149 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -2,6 +2,13 @@ Get Started *********** +{IDF_TARGET_CORE_NUM:default="2", esp32="2", esp32s2="1"} + +{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash"} + +{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900"} + + :link_to_translation:`zh_CN:[中文]` .. Please keep README.md in sync with these instructions. @@ -569,14 +576,15 @@ After startup and diagnostic logs scroll up, you should see "Hello world!" print .. code-block:: none - ... - Hello world! - Restarting in 10 seconds... - This is esp32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 1, 2MB external flash - Restarting in 9 seconds... - Restarting in 8 seconds... - Restarting in 7 seconds... - + ... + Hello world! + Restarting in 10 seconds... + This is {IDF_TARGET_PATH_NAME} chip with {IDF_TARGET_CORE_NUM} CPU core(s), {IDF_TARGET_FEATURES} + Minimum free heap size: {IDF_TARGET_HEAP_SIZE} bytes + Restarting in 9 seconds... + Restarting in 8 seconds... + Restarting in 7 seconds... + To exit IDF monitor use the shortcut ``Ctrl+]``. .. only:: esp32 diff --git a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst index d6a81dc2ce..015536e87f 100644 --- a/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst +++ b/docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst @@ -21,7 +21,7 @@ ESP-BLE-MESH 的实现和认证基于最新的 `Mesh Profile v1.0.1 `。 + 如果您在寻找 ESP32 基于 Wi-Fi 的 mesh 方案，请查阅乐鑫的另一款产品 ESP-MESH。更多相关信息及文档，请参见 :doc:`ESP-MESH <../../api-reference/network/esp_mesh>`。 .. _getting-started-with-ble-mesh: @@ -32,7 +32,7 @@ ESP-BLE-MESH 快速入门 我们将会展示如何搭建并运行一个包含 3 个节点的小型 ESP-BLE-MESH 网络，其中包含设备配网、节点配置，以及向特定节点上的 Generic OnOff Server Model 发送开关灯命令。 -如果您是第一次接触 ESP-IDF，请参见 esp-idf :doc:../../get-started/index 来设置开发环境，编译、烧写和运行示例应用程序。 +如果您是第一次接触 ESP-IDF，请参见 esp-idf :doc:`../../get-started/index` 来设置开发环境，编译、烧写和运行示例应用程序。 硬件及软件准备 -------------- @@ -218,7 +218,7 @@ ESP-BLE-MESH 示例 * :example_file:`ESP-BLE-MESH Provisioner ` - 展示了设备如何充当 ESP-BLE-MESH Provisioner 以配网设备。Provisioner 拥有 Configuration Server model、Configuration Client model 和 Generic OnOff Client model，示例请见 :example:`example code `。 -* ESP-BLE-MESH 快速配网 - :example_file:`Client ` 和 :example_file`Server ` - 该示例用于演示快速配网。配网 100 个设备费时不超过 60 秒，示例请见：:example:`example client code ` 和 :example:`example server code `。 +* ESP-BLE-MESH 快速配网 - :example_file:`Client ` 和 :example_file:`Server ` - 该示例用于演示快速配网。配网 100 个设备费时不超过 60 秒，示例请见：:example:`example client code ` 和 :example:`example server code `。 * :example_file:`Wi-Fi 和 ESP-BLE-MESH 共存 ` - 该示例用于演示 Wi-Fi 和 ESP-BLE-MESH 共存的功能。简而言之，用户可在运行 ESP-BLE-MESH 时使用 Wi-Fi，示例请见 :example:`example code `。 diff --git a/docs/zh_CN/api-guides/tools/idf-monitor.rst b/docs/zh_CN/api-guides/tools/idf-monitor.rst index 0b8d8b7b14..da1bf2a03f 100644 --- a/docs/zh_CN/api-guides/tools/idf-monitor.rst +++ b/docs/zh_CN/api-guides/tools/idf-monitor.rst @@ -113,7 +113,7 @@ IDF 监视器有两种启用方式：运行 ``idf.py monitor PRINT_FILTER=""`` .. note:: 编译时，可以使用主日志在 :doc:`日志库 <../../api-reference/system/log>` 中禁用不需要的输出。也可以使用 IDF 监视器筛选输出来调整筛选设置，且无需重新编译应用程序。 -应用程序标签不能包含空格、星号 ``*``、分号 ``:``，以便兼容输出筛选功能。 +应用程序标签不能包含空格、星号 ``*``、冒号 ``:``，以便兼容输出筛选功能。 如果应用程序输出的最后一行后面没有回车，可能会影响输出筛选功能，即，监视器开始打印该行，但后来发现该行不应该被写入。这是一个已知问题，可以通过添加回车来避免此问题（特别是在没有输出紧跟其后的情况下）。 diff --git a/docs/zh_CN/get-started/index.rst b/docs/zh_CN/get-started/index.rst index f7926b793a..15f80e05d5 100644 --- a/docs/zh_CN/get-started/index.rst +++ b/docs/zh_CN/get-started/index.rst @@ -2,6 +2,12 @@ 快速入门 *********** +{IDF_TARGET_CORE_NUM:default="2", esp32="2", esp32s2="1"} + +{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash"} + +{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900"} + :link_to_translation:`en:[English]` 本文档旨在指导用户搭建 {IDF_TARGET_NAME} 硬件开发的软件环境，通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 {IDF_TARGET_NAME} 开发板等步骤。 @@ -471,13 +477,14 @@ Windows 操作系统 .. code-block:: none - ... - Hello world! - Restarting in 10 seconds... - I (211) cpu_start: Starting scheduler on APP CPU. - Restarting in 9 seconds... - Restarting in 8 seconds... - Restarting in 7 seconds... + ... + Hello world! + Restarting in 10 seconds... + This is {IDF_TARGET_PATH_NAME} chip with {IDF_TARGET_CORE_NUM} CPU core(s), {IDF_TARGET_FEATURES} + Minimum free heap size: {IDF_TARGET_HEAP_SIZE} bytes + Restarting in 9 seconds... + Restarting in 8 seconds... + Restarting in 7 seconds... 您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。 diff --git a/examples/get-started/hello_world/main/hello_world_main.c b/examples/get-started/hello_world/main/hello_world_main.c index 53ed3bf5de..ebc5eb0b04 100644 --- a/examples/get-started/hello_world/main/hello_world_main.c +++ b/examples/get-started/hello_world/main/hello_world_main.c @@ -20,7 +20,7 @@ void app_main(void) /* Print chip information */ esp_chip_info_t chip_info; esp_chip_info(&chip_info); - printf("This is %s chip with %d CPU cores, WiFi%s%s, ", + printf("This is %s chip with %d CPU core(s), WiFi%s%s, ", CONFIG_IDF_TARGET, chip_info.cores, (chip_info.features & CHIP_FEATURE_BT) ? "/BT" : "",