1与 {IDF_TARGET_NAME} 创建串口连接
2==============================================
3
4:link_to_translation:`en:[English]`
5
6本章节主要介绍如何创建 {IDF_TARGET_NAME} 和 PC 之间的串口连接。
7
8
9连接 {IDF_TARGET_NAME} 和 PC
10------------------------------
11
12用 USB 线将 {IDF_TARGET_NAME} 开发板连接到 PC。如果设备驱动程序没有自动安装，请先确认 {IDF_TARGET_NAME} 开发板上的 USB 转串口芯片（或外部转串口适配器）型号，然后在网上搜索驱动程序，并进行手动安装。
13
14以下是乐鑫 {IDF_TARGET_NAME} 开发板驱动程序的链接：
15
16* CP210x: `CP210x USB 至 UART 桥 VCP 驱动程序 <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
17* FTDI: `FTDI 虚拟 COM 端口驱动程序 <https://www.ftdichip.com/Drivers/VCP.htm>`_
18
19以上驱动仅供参考，请参考开发板用户指南，查看开发板具体使用的 USB 转串口芯片。一般情况下，当 {IDF_TARGET_NAME} 开发板与 PC 连接时，对应驱动程序应该已经被打包在操作系统中，并已经自动安装。
20
21在 Windows 上查看端口
22---------------------
23
24检查 Windows 设备管理器中的 COM 端口列表。断开 {IDF_TARGET_NAME} 与 PC 的连接，然后重新连接，查看哪个端口从列表中消失后又再次出现。
25
26以下为 ESP32 DevKitC 和 ESP32 WROVER KIT 串口：
27
28.. figure:: ../../_static/esp32-devkitc-in-device-manager.png
29    :align: center
30    :alt: 设备管理器中 ESP32-DevKitC 的 USB 至 UART 桥
31    :figclass: align-center
32
33    设备管理器中 ESP32-DevKitC 的 USB 至 UART 桥
34
35.. figure:: ../../_static/esp32-wrover-kit-in-device-manager.png
36    :align: center
37    :alt: Windows 设备管理器中 ESP-WROVER-KIT 的两个 USB 串行端口
38    :figclass: align-center
39
40    Windows 设备管理器中 ESP-WROVER-KIT 的两个 USB 串行端口
41
42
43在 Linux 和 macOS 上查看端口
44-----------------------------
45
46查看 {IDF_TARGET_NAME} 开发板（或外部转串口适配器）的串口设备名称，请将以下命令运行两次。首先，断开开发板或适配器，首次运行以下命令；然后，连接开发板或适配器，再次运行以下命令。其中，第二次运行命令后出现的端口即是 {IDF_TARGET_NAME} 对应的串口：
47
48Linux::
49
50    ls /dev/tty*
51
52macOS::
53
54    ls /dev/cu.*
55
56.. 注解::
57
58    对于 macOS 用户：若你没有看到串口，请检查你是否已按照《入门指南》安装了适用于你特定开发板的 USB/串口驱动程序。对于 macOS High Sierra (10.13) 的用户，你可能还需要手动允许驱动程序的加载，具体可打开 ``系统偏好设置`` -> ``安全和隐私`` -> ``通用``，检查是否有信息显示：“来自开发人员的系统软件...”，其中开发人员的名称为 Silicon Labs 或 FTDI。
59
60
61.. _linux-dialout-group:
62
63在 Linux 中添加用户到 ``dialout``
64-----------------------------------
65
66当前登录用户应当可以通过 USB 对串口进行读写操作。在多数 Linux 版本中，您都可以通过以下命令，将用户添加到 ``dialout`` 组，从而获许读写权限::
67
68    sudo usermod -a -G dialout $USER
69
70在 Arch Linux 中，需要通过以下命令将用户添加到 ``uucp`` 组中::
71
72    sudo usermod -a -G uucp $USER
73
74请重新登录，确保串口读写权限生效。
75
76
77确认串口连接
78------------------------
79
80现在，请使用串口终端程序，查看重置 {IDF_TARGET_NAME} 后终端上是否有输出，从而验证串口连接是否可用。
81
82Windows 和 Linux 操作系统
83^^^^^^^^^^^^^^^^^^^^^^^^^^^^
84
85在本示例中，我们将使用 `PuTTY SSH Client <https://www.putty.org/>`_， `PuTTY SSH Client <https://www.putty.org/>`_ 既可用于 Windows 也可用于 Linux。你也可以使用其他串口程序并设置如下的通信参数。
86
87运行终端，配置在上述步骤中确认的串口：波特率 = 115200，数据位 = 8，停止位 = 1，奇偶校验 = N。以下截屏分别展示了如何在 Windows 和 Linux 中配置串口和上述通信参数（如 115200-8-1-N）。注意，这里一定要选择在上述步骤中确认的串口进行配置。
88
89.. figure:: ../../_static/putty-settings-windows.png
90    :align: center
91    :alt: 在 Windows 操作系统中使用 PuTTY 设置串口通信参数
92    :figclass: align-center
93
94    在 Windows 操作系统中使用 PuTTY 设置串口通信参数
95
96.. figure:: ../../_static/putty-settings-linux.png
97    :align: center
98    :alt: 在 Linux 操作系统中使用 PuTTY 设置串口通信参数
99    :figclass: align-center
100
101    在 Linux 操作系统中使用 PuTTY 设置串口通信参数
102
103
104然后，请检查 {IDF_TARGET_NAME} 是否有打印日志。如有，请在终端打开串口进行查看。这里的日志内容取决于加载到 {IDF_TARGET_NAME} 的应用程序，请参考 `输出示例`_。
105
106.. 注解::
107
108   请在验证完串口通信正常后，关闭串口终端。如果您让终端一直保持打开的状态，之后上传固件时将无法访问串口。
109
110macOS 操作系统
111^^^^^^^^^^^^^^^^^
112
113macOS 提供了 **屏幕** 命令，因此您不用安装串口终端程序。
114
115- 参考 `在 Linux 和 macOS 上查看端口`_，运行以下命令::
116
117    ls /dev/cu.*
118
119- 您会看到类似如下输出::
120
121    /dev/cu.Bluetooth-Incoming-Port /dev/cu.SLAB_USBtoUART      /dev/cu.SLAB_USBtoUART7
122
123- 根据您连接到电脑上的开发板类型和数量，输出结果会有所不同。请选择开发板的设备名称，并运行以下命令::
124
125    screen /dev/cu.device_name 115200
126
127将 ``device_name`` 替换为运行 ``ls /dev/cu.*`` 后出现的设备串口号。
128
129- 您需要的正是 **屏幕** 显示的日志。日志内容取决于加载到 {IDF_TARGET_NAME} 的应用程序，请参考 `输出示例`_。请使用 Ctrl-A + \\ 键退出 **屏幕** 会话。
130
131.. 注解::
132
133   请在验证完串口通信正常后，关闭 **屏幕** 会话。如果直接关闭终端窗口而没有关闭 **屏幕**，之后上传固件时将无法访问串口。
134
135
136输出示例
137^^^^^^^^^^^
138
139以下是 {IDF_TARGET_NAME} 的一个日志示例。如果没看到任何输出，请尝试重置开发板。
140
141.. highlight:: none
142
143::
144
145    ets Jun  8 2016 00:22:57
146
147    rst:0x5 (DEEPSLEEP_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
148    ets Jun  8 2016 00:22:57
149
150    rst:0x7 (TG0WDT_SYS_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
151    configsip: 0, SPIWP:0x00
152    clk_drv:0x00,q_drv:0x00,d_drv:0x00,cs0_drv:0x00,hd_drv:0x00,wp_drv:0x00
153    mode:DIO, clock div:2
154    load:0x3fff0008,len:8
155    load:0x3fff0010,len:3464
156    load:0x40078000,len:7828
157    load:0x40080000,len:252
158    entry 0x40080034
159    I (44) boot: ESP-IDF v2.0-rc1-401-gf9fba35 2nd stage bootloader
160    I (45) boot: compile time 18:48:10
161
162    ...
163
164如果打印出的日志是可读的（而不是乱码），则表示串口连接正常。此时，您可以继续进行安装，并最终将应用程序上载到 {IDF_TARGET_NAME}。
165
166.. 注解::
167
168   在某些串口接线方式下，在 {IDF_TARGET_NAME} 启动并开始打印串口日志前，需要在终端程序中禁用串口 RTS ＆ DTR 管脚。该问题仅存在于将 RTS ＆ DTR 管脚直接连接到 EN ＆ GPIO0 管脚上的情况，绝大多数开发板（包括乐鑫所有的开发板）都没有这个问题。更多详细信息，请参考 `esptool 文档`_。
169
170如您在安装 {IDF_TARGET_NAME} 硬件开发的软件环境时，从 :ref:`get-started-connect` 跳转到了这里，请从 :ref:`get-started-configure` 继续阅读。
171
172.. _esptool 文档: https://github.com/espressif/esptool/wiki/ESP32-Boot-Mode-Selection#automatic-bootloader