Skip to content

Commit

Permalink
Merge branch 'update/docs_h2_protocols' into 'master'
Browse files Browse the repository at this point in the history
docs: Update Protocols & Provisioning sections for H2

See merge request espressif/esp-idf!22978
  • Loading branch information
mahavirj committed Mar 31, 2023
2 parents 70c3cdc + 2910050 commit 42261df
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 33 deletions.
11 changes: 0 additions & 11 deletions docs/docs_not_updated/esp32h2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/en/api-reference/protocols/esp_local_ctrl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
24 changes: 13 additions & 11 deletions docs/en/api-reference/provisioning/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
32 changes: 22 additions & 10 deletions docs/en/api-reference/provisioning/protocomm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/en/api-reference/provisioning/provisioning.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Unified Provisioning
^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 2 additions & 0 deletions docs/en/api-reference/provisioning/wifi_provisioning.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Wi-Fi Provisioning
==================

Expand Down

0 comments on commit 42261df

Please sign in to comment.