docs: provide CN translation for MR17066

This commit is contained in:
Shang Zhou 2022-03-10 11:38:33 +08:00 committed by David Cermak
parent 7db0f0feb1
commit 83fcf44e65
7 changed files with 34 additions and 39 deletions

View File

@ -82,7 +82,7 @@ The prerequisites for starting ESP-WIFI-MESH is to initialize LwIP and Wi-Fi, Th
.. code-block:: c
esp_netif_init();
ESP_ERROR_CHECK(esp_netif_init());
/* event initialization */
ESP_ERROR_CHECK(esp_event_loop_create_default());

View File

@ -5,14 +5,14 @@ ESP-IDF 5.0 Migration Guides
.. toctree::
:maxdepth: 1
Build System <build-system>
Environment Setup on Windows <windows-env>
Ethernet <ethernet>
FreeRTOS <freertos>
Peripherals <peripherals>
Protocols <protocols>
Removed or deprecated components <removed-components>
Storage <storage>
System <system>
Tools <tools>
TCP/IP Adapter <tcpip-adapter>
build-system
windows-env
ethernet
freertos
peripherals
protocols
removed-components
storage
system
tools
tcpip-adapter

View File

@ -3,7 +3,7 @@ TCP/IP Adapter Migration Guide
:link_to_translation:`zh_CN:[中文]`
TCP/IP Adapter was a network interface abstraction component used in IDF prior to v4.1. This page outlines migration from tcpip_adapter API to its successor :doc:`/api-reference/network/esp_netif`.
TCP/IP Adapter was a network interface abstraction component used in ESP-IDF prior to v4.1. This page outlines migration from tcpip_adapter API to its successor :doc:`/api-reference/network/esp_netif`.
Updating network connection code

View File

@ -65,9 +65,8 @@ LwIP & ESP-WIFI-MESH
应用程序无需通过 LwIP 层便可直接访问 ESP-WIFI-MESH 软件栈LwIP 层仅在根节点和外部 IP 网络的数据发送与接收时会用到。但是,由于每个节点都有可能成为根节点(由于自动根节点选择机制的存在),每个节点仍必须初始化 LwIP 软件栈。
**每个节点都需要通过调用** :cpp:func:`esp_netif_init`
**可成为根节点的每个节点都需要通过调用** :cpp:func:`esp_netif_init` **来初始化 LwIP 软件栈**。为了防止非根节点访问 LwIP应用程序不应使用 esp_netif API 创建或注册任何网络接口
.. note::
ESP-WIFI-MESH 的根节点必须与路由器连接。因此,当一个节点成为根节点时,**该节点对应的处理程序必须启动 DHCP 客户端服务并立即获取 IP 地址。** 这样做将允许其他节点开始向/从外部 IP 网络发送/接收数据包。但是,如果使用静态 IP 设置,则不需要执行此步骤。
@ -317,4 +316,3 @@ API 参考
--------------
.. include-build-file:: inc/esp_mesh.inc

View File

@ -59,7 +59,6 @@ IP 网络层协议
TCP/IP 套接字 API 的示例代码存放在 ESP-IDF 示例项目的 :example:`protocols/sockets` 目录下。
应用层协议 
===========

View File

@ -5,14 +5,14 @@ ESP-IDF 5.0 迁移指南
.. toctree::
:maxdepth: 1
Environment Setup on Windows <windows-env>
外设 <peripherals>
构建系统 <build-system>
系统 <system>
FreeRTOS <freertos>
以太网 <ethernet>
Storage <storage>
Protocols <protocols>
Removed or deprecated components <removed-components>
Tools <tools>
TCPIP Adapter <tcpip-adapter>
build-system
windows-env
ethernet
freertos
peripherals
protocols
removed-components
storage
system
tools
tcpip-adapter

View File

@ -3,7 +3,7 @@ TCP/IP 适配器迁移指南
:link_to_translation:`en:[英文]`
TCP/IP 适配器是在 IDF V4.1之前使用的网络接口抽象组件。本文档概述了从 tcpip_adapter 移出至其后继者 :doc:`/api-reference/network/esp_netif` 的过程。
TCP/IP 适配器是在 ESP-IDF v4.1 之前使用的网络接口抽象组件。本文档概述了从 tcpip_adapter 移出至其后继者 :doc:`/api-reference/network/esp_netif` 的过程。
更新网络连接代码
@ -28,8 +28,7 @@ TCP/IP 适配器静态定义了三个接口:
- 以太网
网络接口的设计应严格参考 :doc:`/api-reference/network/esp_netif`,以使其能够连接到 TCP/IP 软件栈。
例如,在 TCP/IP 软件栈和事件循环初始化完成后Wi-Fi 的初始化代码必须显示调用 ``esp_netif_create_default_wifi_sta();````esp_netif_create_default_wifi_ap();``
例如,在 TCP/IP 软件栈和事件循环初始化完成后Wi-Fi 的初始化代码必须显示调用 ``esp_netif_create_default_wifi_sta();````esp_netif_create_default_wifi_ap();``
请参阅这三个接口的初始化代码示例:
- Wi-Fi Station: :example_file:`wifi/getting_started/station/main/station_example_main.c`
@ -37,10 +36,10 @@ TCP/IP 适配器静态定义了三个接口:
- 以太网: :example_file:`ethernet/basic/main/ethernet_example_main.c`
更换其他 tcpip_adapter API
更换 tcpip_adapter API
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
所有 tcpip_adapter 函数都有对应的 esp-netif。具体请见 esp_netif 的内容
所有 tcpip_adapter 函数都有对应的 esp-netif。请参阅 esp_netif.h 查看更多信息
* :component_file:`Setters/Getters <esp_netif/include/esp_netif.h#L241>`
* :component_file:`DHCP <esp_netif/include/esp_netif.h#L387>`
@ -52,20 +51,20 @@ TCP/IP 适配器静态定义了三个接口:
^^^^^^^^^^^^^^^^^^^^^^
事件处理程序已经从 tcpip_adapter 移动到相应的驱动程序代码。从应用程序的角度来看,这不会带来任何影响,所有事件仍以相同的方式处理。
请注意,在与 IP 相关的事件处理程序中,应用程序代码通常以 esp-netif 结构体的形式接收 IP 地址(不是 LwIP 结构,但兼容二进制格式)
这是打印地址的首选方式:
请注意,在与 IP 相关的事件处理程序中,应用程序代码通常以 esp-netif 结构体的形式接收 IP 地址,该结构体并非 LwIP 结构,但兼容二进制格式
打印地址的首选方式如下所示
.. code-block:: c
ESP_LOGI(TAG, "got ip:" IPSTR "\n", IP2STR(&event->ip_info.ip));
而不是
不建议使用下述方式:
.. code-block:: c
ESP_LOGI(TAG, "got ip:%s\n", ip4addr_ntoa(&event->ip_info.ip));
由于 ``ip4addr_ntoa()`` 为 LwIP API因此 esp-netif 还提供了替代函数 ``esp_ip4addr_ntoa()``,但整体而言仍推荐上述方法。
由于 ``ip4addr_ntoa()`` 为 LwIP API因此 esp-netif 还提供了替代函数 ``esp_ip4addr_ntoa()``,但整体而言,仍推荐使用第一种方法。
IP 地址
@ -78,7 +77,6 @@ IP 地址
下一步
^^^^^^^^^^
为了移植应用程序使其可以使用 :doc:`/api-reference/network/esp_netif` 还需完成的步骤包括:在组件配置中禁用 tcpip_adapter 兼容层。
为了移植应用程序可以使用 :doc:`/api-reference/network/esp_netif`,还需在组件配置中禁用 tcpip_adapter 兼容层。
方法为:``ESP NETIF Adapter`` -> ``Enable backward compatible tcpip_adapter interface``,并检查工程是否编译成功。
TCP/IP 适配器涉及大量依赖项,这一步可能有助于将应用程序与使用特定 TCP/IP 软件栈的 API 分离开来。