From 96db6f906ac1b27c1ffd10fb0b0cddcc63607a0a Mon Sep 17 00:00:00 2001 From: Natasha Date: Wed, 29 May 2019 18:11:40 +0800 Subject: [PATCH] Docs/update idf monitor --- docs/en/api-guides/tools/idf-monitor.rst | 2 ++ docs/zh_CN/api-guides/tools/idf-monitor.rst | 38 ++++++++------------- 2 files changed, 17 insertions(+), 23 deletions(-) diff --git a/docs/en/api-guides/tools/idf-monitor.rst b/docs/en/api-guides/tools/idf-monitor.rst index 90a23d1bc2..8a7df3fb5a 100644 --- a/docs/en/api-guides/tools/idf-monitor.rst +++ b/docs/en/api-guides/tools/idf-monitor.rst @@ -2,6 +2,8 @@ IDF Monitor *********** +:link_to_translation:`zh_CN:[中文]` + The IDF monitor tool is mainly a serial terminal program which relays serial data to and from the target device's serial port. It also provides some IDF-specific features. This tool can be launched by invoking in IDF the following target: diff --git a/docs/zh_CN/api-guides/tools/idf-monitor.rst b/docs/zh_CN/api-guides/tools/idf-monitor.rst index 26fb08473d..3d842fbd13 100644 --- a/docs/zh_CN/api-guides/tools/idf-monitor.rst +++ b/docs/zh_CN/api-guides/tools/idf-monitor.rst @@ -17,29 +17,21 @@ IDF 监视器是一个串行终端程序，用于收发目标设备串口的串 为了方便与 IDF 监视器进行交互，请使用表中给出的快捷键。 -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| 快捷键 | 操作 | 描述 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Ctrl+] | 退出监视器程序 | | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Ctrl+T | 菜单退出键 | 按下如下给出的任意键，并按指示操作。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+T | 将菜单字符发送至远程 | | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+] | 将 exit 字符发送至远程 | | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+P | 重置目标设备，进入 Bootloader，通过 RTS 线暂停应用程序 | 重置目标设备，通过 RTS 线（如已连接）进入 Bootloader，此时开发板不运行任何程序。等待其他设备启动时可以使用此操作。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+R | 通过 RTS 线重置目标设备 | 重置设备，并通过 RTS 线（如已连接）重新启动应用程序。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+F | 编译并烧录此项目 | 暂停 idf_monitor，运行 ``make flash`` (``idf.py flash``) 目标，然后恢复 idf_monitor。任何改动的源文件都会被重新编译，然后重新烧录。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+A | 仅编译及烧录应用程序 | 暂停 idf_monitor，运行 ``app-flash`` 目标，然后恢复 idf_monitor。 这与 ``flash`` 类似，但只有主应用程序被编译并被重新烧录。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+Y | 停止/恢复日志输出在屏幕上打印 | 激活时，会丢弃所有传入的串行数据。允许在不退出监视器的情况下快速暂停和检查日志输出。 | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| - Ctrl+H | 显示所有快捷键 | | -+----------+--------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +=================== ======================================================================== ======================================================================================================================================================================================= +快捷键 操作 描述 +=================== ======================================================================== ======================================================================================================================================================================================= +Ctrl+] 退出监视器程序 +Ctrl+T 菜单退出键 按下如下给出的任意键，并按指示操作。 +- Ctrl+T 将菜单字符发送至远程 +- Ctrl+] 将 exit 字符发送至远程 +- Ctrl+P 重置目标设备，进入 Bootloader，通过 RTS 线暂停应用程序 重置目标设备，通过 RTS 线（如已连接）进入 Bootloader，此时开发板不运行任何程序。等待其他设备启动时可以使用此操作。 +- Ctrl+R 通过 RTS 线重置目标设备 重置设备，并通过 RTS 线（如已连接）重新启动应用程序。 +- Ctrl+F 编译并烧录此项目 暂停 idf_monitor，运行 ``make flash`` (``idf.py flash``) 目标，然后恢复 idf_monitor。任何改动的源文件都会被重新编译，然后重新烧录。 +- Ctrl+A 仅编译及烧录应用程序 暂停 idf_monitor，运行 ``app-flash`` 目标，然后恢复 idf_monitor。 这与 ``flash`` 类似，但只有主应用程序被编译并被重新烧录。 +- Ctrl+Y 停止/恢复日志输出在屏幕上打印 激活时，会丢弃所有传入的串行数据。允许在不退出监视器的情况下快速暂停和检查日志输出。 +- Ctrl+L 停止/恢复向文件写入日志输出 在工程目录下创建一个文件，用于写入日志输出。可使用快捷键停止/恢复该功能（退出 IDF 监视器也会终止该功能） +- Ctrl+H 显示所有快捷键 +=================== ======================================================================== ======================================================================================================================================================================================= 除了 ``Ctrl-]`` 和 ``Ctrl-T``，其他快捷键信号会通过串口发送到目标设备。