mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
docs: Update Protocols & Provisioning sections for H2
This commit is contained in:
parent
6cac537791
commit
2910050060
@ -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
|
||||
|
@ -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:
|
||||
|
||||
|
@ -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`.
|
||||
|
||||
../network/esp_dpp
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`.
|
||||
../network/esp_dpp
|
||||
|
||||
Code example for above API is provided in :example:`wifi/wifi_easy_connect/dpp-enrollee`.
|
||||
|
@ -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
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:orphan:
|
||||
|
||||
Unified Provisioning
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:orphan:
|
||||
|
||||
Wi-Fi Provisioning
|
||||
==================
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user