Merge branch 'docs/remove_wifi_related_documentation_for_esp32h2' into 'master'

docs: remove WiFi related documentation for ESP32-H2

See merge request espressif/esp-idf!27026
This commit is contained in:
Zhang Xiao Yan
2023-12-05 09:58:06 +08:00
9 changed files with 43 additions and 39 deletions

View File

@@ -66,7 +66,9 @@ WIFI_DOCS = ['api-guides/wifi.rst',
'api-reference/network/esp_now.rst',
'api-reference/network/esp_smartconfig.rst',
'api-reference/network/esp_wifi.rst',
'api-reference/network/esp_dpp.rst']
'api-reference/network/esp_dpp.rst',
'api-reference/provisioning/provisioning.rst',
'api-reference/provisioning/wifi_provisioning.rst']
NAN_DOCS = ['api-reference/network/esp_nan.rst']

View File

@@ -28,8 +28,11 @@ Protocomm provides the framework for various transports:
:SOC_WIFI_SUPPORTED: - Wi-Fi (SoftAP + HTTPD)
- Console, in which case the handler invocation is automatically taken care of on the device side. See Transport Examples below for code snippets.
Note that for protocomm_security1 and protocomm_security2, the client still needs to establish sessions by performing the two-way handshake.
Note that for protocomm_security1 and protocomm_security2, the client still needs to establish sessions by performing the two-way handshake. See :doc:`provisioning` for more details about the secure handshake logic.
.. only:: SOC_WIFI_SUPPORTED
See :doc:`provisioning` for more details about the secure handshake logic.
.. _enabling-protocomm-security-version:

View File

@@ -1,5 +1,3 @@
:orphan:
Unified Provisioning
^^^^^^^^^^^^^^^^^^^^

View File

@@ -1,5 +1,3 @@
:orphan:
Wi-Fi Provisioning
==================

View File

@@ -211,16 +211,18 @@ UART Download Mode
Product Security
----------------
Secure Provisioning
~~~~~~~~~~~~~~~~~~~
.. only:: SOC_WIFI_SUPPORTED
Secure Provisioning refers to a process of secure on-boarding of the ESP device on to the Wi-Fi network. This mechanism also allows provision of additional custom configuration data during the initial provisioning phase from the provisioning entity, e.g., Smartphone.
Secure Provisioning
~~~~~~~~~~~~~~~~~~~
ESP-IDF provides various security schemes to establish a secure session between ESP and the provisioning entity, they are highlighted at :ref:`provisioning_security_schemes`.
Secure Provisioning refers to a process of secure on-boarding of the ESP device on to the Wi-Fi network. This mechanism also allows provision of additional custom configuration data during the initial provisioning phase from the provisioning entity, e.g., Smartphone.
Please refer to the :doc:`../api-reference/provisioning/wifi_provisioning` documentation for details and the example code for this feature.
ESP-IDF provides various security schemes to establish a secure session between ESP and the provisioning entity, they are highlighted at :ref:`provisioning_security_schemes`.
.. note::
Please refer to the :doc:`../api-reference/provisioning/wifi_provisioning` documentation for details and the example code for this feature.
.. note::
Espressif provides Android and iOS Phone Apps along with their sources, so that it could be easy to further customize them as per the product requirement.

View File

@@ -28,8 +28,11 @@ Protocomm 为以下各种传输提供框架:
:SOC_WIFI_SUPPORTED: - Wi-Fi (SoftAP + HTTPD)
- 控制台:使用该传输方案时,设备端会自动调用处理程序。相关代码片段,请参见下文传输示例。
请注意,对于 ``protocomm_security1````protocomm_security2``,客户端仍需要执行双向握手来建立会话。
请注意,对于 ``protocomm_security1````protocomm_security2``,客户端仍需要执行双向握手来建立会话。关于安全握手逻辑的详情,请参阅 :doc:`provisioning`
.. only:: SOC_WIFI_SUPPORTED
关于安全握手逻辑的详情,请参阅 :doc:`provisioning`
.. _enabling-protocomm-security-version:

View File

@@ -1,5 +1,3 @@
:orphan:
统一配网
^^^^^^^^^^^^^^^^^^^^

View File

@@ -1,5 +1,3 @@
:orphan:
Wi-Fi 配网
====================

View File

@@ -197,16 +197,18 @@ UART 下载模式
产品安全
----------------
安全配网
~~~~~~~~~~~~~~~~~~~
.. only:: SOC_WIFI_SUPPORTED
安全配网是指将 ESP 设备安全接入 Wi-Fi 网络的过程。该机制还支持在初始配网阶段从配网实体(如智能手机等)获取额外的自定义配置数据。
安全配网
~~~~~~~~~~~~~~~~~~~
ESP-IDF 提供了多种安全方案,可以在 ESP 设备和配网实体之间建立安全会话,具体方案请参阅 :ref:`provisioning_security_schemes`
安全配网是指将 ESP 设备安全接入 Wi-Fi 网络的过程。该机制还支持在初始配网阶段从配网实体(如智能手机等)获取额外的自定义配置数据
关于该功能的更多详情和代码示例,请参阅 :doc:`../api-reference/provisioning/wifi_provisioning`
ESP-IDF 提供了多种安全方案,可以在 ESP 设备和配网实体之间建立安全会话,具体方案请参阅 :ref:`provisioning_security_schemes`
.. note::
关于该功能的更多详情和代码示例,请参阅 :doc:`../api-reference/provisioning/wifi_provisioning`
.. note::
乐鑫提供了 Android 和 iOS 手机应用程序及其源代码,以便进一步根据产品需求定制安全配网方案。