From 09b53af171663e9f9c0edb267c914158209ddd65 Mon Sep 17 00:00:00 2001 From: Linda Date: Thu, 18 Jul 2024 16:39:46 +0800 Subject: [PATCH] docs: update application examples for esp_nan.rst, esp_dpp.rst and wifi-security.rst --- docs/en/api-guides/wifi-security.rst | 4 +++- docs/en/api-reference/network/esp_dpp.rst | 6 +++--- docs/en/api-reference/network/esp_nan.rst | 10 +++++++--- docs/zh_CN/api-guides/wifi-security.rst | 4 +++- docs/zh_CN/api-reference/network/esp_dpp.rst | 2 +- docs/zh_CN/api-reference/network/esp_nan.rst | 6 +++++- 6 files changed, 22 insertions(+), 10 deletions(-) diff --git a/docs/en/api-guides/wifi-security.rst b/docs/en/api-guides/wifi-security.rst index 191d7f3c50..ec01f17157 100644 --- a/docs/en/api-guides/wifi-security.rst +++ b/docs/en/api-guides/wifi-security.rst @@ -62,7 +62,9 @@ Enterprise security is the secure authentication mechanism for enterprise wirele - MSCHAP and MSCHAP-V2. - EAP-FAST: This is an authentication method based on Protected Access Credentials (PAC) which also uses identity and password. Currently, :ref:`CONFIG_ESP_WIFI_MBEDTLS_TLS_CLIENT` flag should be disabled to use this feature. -Example :example:`wifi/wifi_enterprise` demonstrates all the supported Wi-Fi Enterprise methods except EAP-FAST. Please refer :example:`wifi/wifi_eap_fast` for the EAP-FAST example. EAP method can be selected from the Example Configuration menu in ``idf.py menuconfig``. Refer to :idf_file:`examples/wifi/wifi_enterprise/README.md` for information on how to generate certificates and run the example. +- :example:`wifi/wifi_eap_fast` demonstrates how to connect {IDF_TARGET_NAME} to an AP with Wi-Fi Enterprise authentication using EAP-FAST, including the installation of a CA certificate, setting user credentials, enabling Wi-Fi Enterprise mode, and handling connection to the AP. + +- :example:`wifi/wifi_enterprise` demonstrates how to connect {IDF_TARGET_NAME} to an AP with Wi-Fi Enterprise authentication using other EAP methods, such as EAP-TLS, EAP-PEAP, EAP-TTLS. For details on generating certificates with OpenSSL commands and running the example, refer to :example_file:`wifi/wifi_enterprise/README.md`. WPA3-Personal ------------- diff --git a/docs/en/api-reference/network/esp_dpp.rst b/docs/en/api-reference/network/esp_dpp.rst index b3ac3e97a2..e7b8526577 100644 --- a/docs/en/api-reference/network/esp_dpp.rst +++ b/docs/en/api-reference/network/esp_dpp.rst @@ -18,10 +18,10 @@ Please refer to Wi-Fi Alliance's official page on `Easy Connect `_ for more information. Many Android smartphones with Android 8 or higher support Wi-Fi Aware. Refer to Android's developer guide on Wi-Fi Aware `Wi-Fi Aware `_ for more information. -Application Example -------------------- +Application Examples +-------------------- -A pair of examples for a Publisher-Subscriber use case: :example:`wifi/wifi_aware/nan_publisher` and :example:`wifi/wifi_aware/nan_subscriber`. A user interactive console example to explore full functionality of Wi-Fi Aware: :example:`wifi/wifi_aware/nan_console`. Please check the `README` for more details in respective example directories. +- :example:`wifi/wifi_aware/nan_console` demonstrates how to use the NAN protocol to discover services in proximity, establish a datapath, and communicate between devices without requiring an Internet or AP connection. It provides console commands for configuring NAN services, publishing or subscribing to a service, sending messages, and initiating or terminating a datapath. + +- :example:`wifi/wifi_aware/nan_publisher` demonstrates how to use the NAN protocol to publish a service for advertising a service to other devices in the vicinity, and how to respond to the devices that subscribes to the service. + +- :example:`wifi/wifi_aware/nan_subscriber` demonstrates how to use the NAN protocol to discover other devices that publishes the required service in the proximity, and communicate with them either by sending a message or initiating a datapath. API Reference ------------- diff --git a/docs/zh_CN/api-guides/wifi-security.rst b/docs/zh_CN/api-guides/wifi-security.rst index 1e3b9c0d68..f7c666a71c 100644 --- a/docs/zh_CN/api-guides/wifi-security.rst +++ b/docs/zh_CN/api-guides/wifi-security.rst @@ -62,7 +62,9 @@ API 及用法 - MSCHAP 和 MSCHAP-V2 - EAP-FAST：该认证方法基于受保护访问凭证 (PAC) 实现，同时也使用身份和密码。目前，需禁用 :ref:`CONFIG_ESP_WIFI_MBEDTLS_TLS_CLIENT` 标志以使用此功能。 -示例 :example:`wifi/wifi_enterprise` 展示了除 EAP-FAST 之外的所有支持的企业级 Wi-Fi 方法。有关 ESP-FAST 的示例，请参阅 :example:`wifi/wifi_eap_fast`。可以在 ``idf.py menuconfig`` 的示例配置菜单中选择 EAP 方法。请参阅 :idf_file:`examples/wifi/wifi_enterprise/README.md` 了解如何生成证书及如何运行示例。 +- :example:`wifi/wifi_eap_fast` 演示如何使用 EAP-FAST 通过企业级 Wi-Fi 认证将 {IDF_TARGET_NAME} 连接到 AP，包括 CA 证书的安装、用户凭据的设置、启用 Wi-Fi 企业模式以及如何连接到 AP。 + +- :example:`wifi/wifi_enterprise` 演示如何使用除 ESP-FAST 之外的其他 EAP 方法（如 EAP-TLS、EAP-PEAP、EAP-TTLS）通过 Wi-Fi 企业认证将 {IDF_TARGET_NAME} 连接到 AP。有关使用 OpenSSL 命令生成证书和运行示例的详细信息，请参阅 :example_file:`wifi/wifi_enterprise/README.md`。 个人级 WPA3 ------------- diff --git a/docs/zh_CN/api-reference/network/esp_dpp.rst b/docs/zh_CN/api-reference/network/esp_dpp.rst index fcb62d41d6..0ab2c6aadb 100644 --- a/docs/zh_CN/api-reference/network/esp_dpp.rst +++ b/docs/zh_CN/api-reference/network/esp_dpp.rst @@ -21,7 +21,7 @@ Easy Connect 协议仍在不断发展。目前已知支持二维码的平台为 应用示例 ------------------- -如需了解使用智能手机配置 {IDF_TARGET_NAME} 的示例，请前往 :example:`wifi/wifi_easy_connect/dpp-enrollee`。 +- :example:`wifi/wifi_easy_connect/dpp-enrollee` 演示如何使用 DPP 将 {IDF_TARGET_NAME} 配置为注册设备，通过二维码和 Android 10 及以上的设备安全地将 ESP 设备接入网络。 API 参考 ------------- diff --git a/docs/zh_CN/api-reference/network/esp_nan.rst b/docs/zh_CN/api-reference/network/esp_nan.rst index 8dca45a5c8..8dde70f378 100644 --- a/docs/zh_CN/api-reference/network/esp_nan.rst +++ b/docs/zh_CN/api-reference/network/esp_nan.rst @@ -12,7 +12,11 @@ Wi-Fi Aware\ :sup:`TM`，也可称为 NAN (Neighbor Awareness Networking) 协议 应用示例 ------------------- -如需查看发布者和订阅者示例，请前往 :example:`wifi/wifi_aware/nan_publisher` 和 :example:`wifi/wifi_aware/nan_subscriber`。如需探索 Wi-Fi Aware 的全部功能，请参考用户交互界面控制台示例 :example:`wifi/wifi_aware/nan_console`。如需了解更多信息，请参考对应示例目录中的 `README` 文档。 +- :example:`wifi/wifi_aware/nan_console` 演示如何使用 NAN 协议发现附近的服务、建立数据路径，并在设备之间进行通信，无需互联网或 AP 连接。它提供了配置 NAN 服务、发布或订阅服务、发送消息以及启动或终止数据路径的控制台命令。 + +- :example:`wifi/wifi_aware/nan_publisher` 演示如何使用 NAN 协议发布服务，将服务广播给附近的其他设备，以及如何响应订阅该服务的设备。 + +- :example:`wifi/wifi_aware/nan_subscriber` 演示如何使用 NAN 协议发现附近发布所需服务的其他设备，并通过发送消息或启动数据路径与它们进行通信。 API 参考 -------------