From 2910050060e66e3a1fa0ae86371a798f9e536ce3 Mon Sep 17 00:00:00 2001 From: Harshit Malpani Date: Wed, 29 Mar 2023 14:16:09 +0530 Subject: [PATCH] docs: Update Protocols & Provisioning sections for H2 --- docs/docs_not_updated/esp32h2.txt | 11 ------- .../protocols/esp_local_ctrl.rst | 2 +- docs/en/api-reference/provisioning/index.rst | 24 +++++++------- .../api-reference/provisioning/protocomm.rst | 32 +++++++++++++------ .../provisioning/provisioning.rst | 2 ++ .../provisioning/wifi_provisioning.rst | 2 ++ 6 files changed, 40 insertions(+), 33 deletions(-) diff --git a/docs/docs_not_updated/esp32h2.txt b/docs/docs_not_updated/esp32h2.txt index 53a42d03bd6..f7f241b0c0c 100644 --- a/docs/docs_not_updated/esp32h2.txt +++ b/docs/docs_not_updated/esp32h2.txt @@ -28,10 +28,6 @@ libraries-and-frameworks/libs-frameworks libraries-and-frameworks/index libraries-and-frameworks/cloud-frameworks versions -api-reference/provisioning/protocomm -api-reference/provisioning/provisioning -api-reference/provisioning/index -api-reference/provisioning/wifi_provisioning api-reference/storage/vfs api-reference/storage/spiffs api-reference/storage/wear-levelling @@ -99,16 +95,9 @@ api-reference/bluetooth/index api-reference/bluetooth/esp_gap_ble api-reference/bluetooth/classic_bt api-reference/protocols/esp_serial_slave_link -api-reference/protocols/mbedtls -api-reference/protocols/esp_http_server api-reference/protocols/esp_sdio_slave_protocol -api-reference/protocols/esp_local_ctrl -api-reference/protocols/esp_crt_bundle -api-reference/protocols/esp_http_client -api-reference/protocols/esp_https_server api-reference/protocols/esp_spi_slave_protocol api-reference/protocols/modbus -api-reference/protocols/esp_tls api-reference/protocols/index about resources diff --git a/docs/en/api-reference/protocols/esp_local_ctrl.rst b/docs/en/api-reference/protocols/esp_local_ctrl.rst index ba6298f7c06..4e836e43d36 100644 --- a/docs/en/api-reference/protocols/esp_local_ctrl.rst +++ b/docs/en/api-reference/protocols/esp_local_ctrl.rst @@ -3,7 +3,7 @@ ESP Local Control Overview -------- -ESP Local Control (**esp_local_ctrl**) component in ESP-IDF provides capability to control an ESP device over Wi-Fi + HTTPS or BLE. It provides access to application defined **properties** that are available for reading / writing via a set of configurable handlers. +ESP Local Control (**esp_local_ctrl**) component in ESP-IDF provides capability to control an ESP device over HTTPS or BLE. It provides access to application defined **properties** that are available for reading / writing via a set of configurable handlers. Initialization of the **esp_local_ctrl** service over BLE transport is performed as follows: diff --git a/docs/en/api-reference/provisioning/index.rst b/docs/en/api-reference/provisioning/index.rst index b6c3a85ecb9..148d9c56307 100644 --- a/docs/en/api-reference/provisioning/index.rst +++ b/docs/en/api-reference/provisioning/index.rst @@ -7,21 +7,23 @@ Provisioning API :maxdepth: 1 protocomm - provisioning - wifi_provisioning + :SOC_WIFI_SUPPORTED: provisioning + :SOC_WIFI_SUPPORTED: wifi_provisioning -Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples. +.. only:: SOC_WIFI_SUPPORTED -.. toctree:: - :maxdepth: 1 + Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples. - ../network/esp_smartconfig + .. toctree:: + :maxdepth: 1 -Code example for above API is provided in :example:`wifi/smart_config`. + ../network/esp_smartconfig -.. toctree:: - :maxdepth: 1 + Code example for above API is provided in :example:`wifi/smart_config`. + + .. toctree:: + :maxdepth: 1 - ../network/esp_dpp + ../network/esp_dpp -Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`. + Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`. diff --git a/docs/en/api-reference/provisioning/protocomm.rst b/docs/en/api-reference/provisioning/protocomm.rst index ea48ab35947..c5321e5bba8 100644 --- a/docs/en/api-reference/provisioning/protocomm.rst +++ b/docs/en/api-reference/provisioning/protocomm.rst @@ -15,7 +15,14 @@ Following features are available for provisioning : Protocomm internally uses protobuf (protocol buffers) for secure session establishment. Though users can implement their own security (even without using protobuf). One can even use protocomm without any security layer. -Protocomm provides framework for various transports - WiFi (SoftAP+HTTPD), BLE, console - in which case the handler invocation is automatically taken care of on the device side (see Transport Examples below for code snippets). +Protocomm provides framework for various transports : + +.. list:: + + :SOC_BLE_SUPPORTED: - BLE + :SOC_WIFI_SUPPORTED: - WiFi (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 the client still needs to establish session (for protocomm_security1 and protocomm_security2) by performing the two way handshake. See :doc:`provisioning` for more details about the secure handshake logic. @@ -30,9 +37,12 @@ The respective configuration options can be found as follows: .. note:: Enabling multiple security versions allow to control them dynamically but also increases firmware size. -Transport Example (SoftAP + HTTP) with Security 2 -------------------------------------------------- -For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` +.. only:: SOC_WIFI_SUPPORTED + + Transport Example (SoftAP + HTTP) with Security 2 + ------------------------------------------------- + + For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` .. highlight:: c @@ -149,9 +159,9 @@ For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` protocomm_delete(pc); } -Transport Example (SoftAP + HTTP) with Security 1 -------------------------------------------------- -For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` + Transport Example (SoftAP + HTTP) with Security 1 + ------------------------------------------------- + For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` .. highlight:: c @@ -243,9 +253,11 @@ For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c` protocomm_delete(pc); } -Transport Example (BLE) with Security 0 ---------------------------------------- -For sample usage, see :component_file:`wifi_provisioning/src/scheme_ble.c` +.. only:: SOC_BLE_SUPPORTED + + Transport Example (BLE) with Security 0 + --------------------------------------- + For sample usage, see :component_file:`wifi_provisioning/src/scheme_ble.c` .. highlight:: c diff --git a/docs/en/api-reference/provisioning/provisioning.rst b/docs/en/api-reference/provisioning/provisioning.rst index 9954b87864c..c1cdaf973b1 100644 --- a/docs/en/api-reference/provisioning/provisioning.rst +++ b/docs/en/api-reference/provisioning/provisioning.rst @@ -1,3 +1,5 @@ +:orphan: + Unified Provisioning ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/en/api-reference/provisioning/wifi_provisioning.rst b/docs/en/api-reference/provisioning/wifi_provisioning.rst index 85999f12611..48e0b9e8f39 100644 --- a/docs/en/api-reference/provisioning/wifi_provisioning.rst +++ b/docs/en/api-reference/provisioning/wifi_provisioning.rst @@ -1,3 +1,5 @@ +:orphan: + Wi-Fi Provisioning ==================