forked from espressif/esp-idf
Merge branch 'update/docs_h2_protocols' into 'master'
docs: Update Protocols & Provisioning sections for H2 See merge request espressif/esp-idf!22978
This commit is contained in:
@@ -28,10 +28,6 @@ libraries-and-frameworks/libs-frameworks
|
|||||||
libraries-and-frameworks/index
|
libraries-and-frameworks/index
|
||||||
libraries-and-frameworks/cloud-frameworks
|
libraries-and-frameworks/cloud-frameworks
|
||||||
versions
|
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/vfs
|
||||||
api-reference/storage/spiffs
|
api-reference/storage/spiffs
|
||||||
api-reference/storage/wear-levelling
|
api-reference/storage/wear-levelling
|
||||||
@@ -99,16 +95,9 @@ api-reference/bluetooth/index
|
|||||||
api-reference/bluetooth/esp_gap_ble
|
api-reference/bluetooth/esp_gap_ble
|
||||||
api-reference/bluetooth/classic_bt
|
api-reference/bluetooth/classic_bt
|
||||||
api-reference/protocols/esp_serial_slave_link
|
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_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/esp_spi_slave_protocol
|
||||||
api-reference/protocols/modbus
|
api-reference/protocols/modbus
|
||||||
api-reference/protocols/esp_tls
|
|
||||||
api-reference/protocols/index
|
api-reference/protocols/index
|
||||||
about
|
about
|
||||||
resources
|
resources
|
||||||
|
@@ -3,7 +3,7 @@ ESP Local Control
|
|||||||
|
|
||||||
Overview
|
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:
|
Initialization of the **esp_local_ctrl** service over BLE transport is performed as follows:
|
||||||
|
|
||||||
|
@@ -7,8 +7,10 @@ Provisioning API
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
protocomm
|
protocomm
|
||||||
provisioning
|
:SOC_WIFI_SUPPORTED: provisioning
|
||||||
wifi_provisioning
|
:SOC_WIFI_SUPPORTED: wifi_provisioning
|
||||||
|
|
||||||
|
.. only:: SOC_WIFI_SUPPORTED
|
||||||
|
|
||||||
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
|
Code examples for above API are provided in the :example:`provisioning` directory of ESP-IDF examples.
|
||||||
|
|
||||||
|
@@ -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 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.
|
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,8 +37,11 @@ The respective configuration options can be found as follows:
|
|||||||
|
|
||||||
.. note:: Enabling multiple security versions allow to control them dynamically but also increases firmware size.
|
.. note:: Enabling multiple security versions allow to control them dynamically but also increases firmware size.
|
||||||
|
|
||||||
|
.. only:: SOC_WIFI_SUPPORTED
|
||||||
|
|
||||||
Transport Example (SoftAP + HTTP) with Security 2
|
Transport Example (SoftAP + HTTP) with Security 2
|
||||||
-------------------------------------------------
|
-------------------------------------------------
|
||||||
|
|
||||||
For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c`
|
For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c`
|
||||||
|
|
||||||
.. highlight:: c
|
.. highlight:: c
|
||||||
@@ -243,6 +253,8 @@ For sample usage, see :component_file:`wifi_provisioning/src/scheme_softap.c`
|
|||||||
protocomm_delete(pc);
|
protocomm_delete(pc);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.. only:: SOC_BLE_SUPPORTED
|
||||||
|
|
||||||
Transport Example (BLE) with Security 0
|
Transport Example (BLE) with Security 0
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
For sample usage, see :component_file:`wifi_provisioning/src/scheme_ble.c`
|
For sample usage, see :component_file:`wifi_provisioning/src/scheme_ble.c`
|
||||||
|
@@ -1,3 +1,5 @@
|
|||||||
|
:orphan:
|
||||||
|
|
||||||
Unified Provisioning
|
Unified Provisioning
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
@@ -1,3 +1,5 @@
|
|||||||
|
:orphan:
|
||||||
|
|
||||||
Wi-Fi Provisioning
|
Wi-Fi Provisioning
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user