mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/update_app_utils_docs_for_esp32p4' into 'master'
docs: Update App Utils programming guide docs for ESP32P4 Closes IDF-7768 and IDF-8076 See merge request espressif/esp-idf!29051
This commit is contained in:
Harshit Malpani
commit
ff94741cd1
@ -93,7 +93,6 @@ api-reference/network/esp_nan.rst
|
||||
api-reference/network/esp_wifi.rst
|
||||
api-reference/network/index.rst
|
||||
api-reference/system/sleep_modes.rst
|
||||
api-reference/system/ota.rst
|
||||
api-reference/system/app_trace.rst
|
||||
api-reference/system/ulp_macros.rst
|
||||
api-reference/system/ulp-lp-core.rst
|
||||
@ -103,19 +102,11 @@ api-reference/system/random.rst
|
||||
api-reference/system/power_management.rst
|
||||
api-reference/system/misc_system_api.rst
|
||||
api-reference/system/inc/power_management_esp32p4.rst
|
||||
api-reference/system/esp_https_ota.rst
|
||||
api-reference/system/ulp-risc-v.rst
|
||||
api-reference/index.rst
|
||||
api-reference/protocols/icmp_echo.rst
|
||||
api-reference/protocols/esp_serial_slave_link.rst
|
||||
api-reference/protocols/mbedtls.rst
|
||||
api-reference/protocols/esp_http_server.rst
|
||||
api-reference/protocols/esp_sdio_slave_protocol.rst
|
||||
api-reference/protocols/esp_local_ctrl.rst
|
||||
api-reference/protocols/esp_crt_bundle.rst
|
||||
api-reference/protocols/esp_http_client.rst
|
||||
api-reference/protocols/esp_https_server.rst
|
||||
api-reference/protocols/esp_tls.rst
|
||||
api-reference/protocols/index.rst
|
||||
security/host-based-security-workflows.rst
|
||||
security/flash-encryption.rst
|
||||
|
||||
@ -8,44 +8,46 @@ Overview
|
||||
|
||||
ESP Local Control (**esp_local_ctrl**) component in ESP-IDF provides capability to control an ESP device over HTTPS or Bluetooth® Low Energy. 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 Bluetooth Low Energy transport is performed as follows:
|
||||
.. only:: SOC_BT_SUPPORTED
|
||||
|
||||
.. code-block:: c
|
||||
Initialization of the **esp_local_ctrl** service over Bluetooth Low Energy transport is performed as follows:
|
||||
|
||||
esp_local_ctrl_config_t config = {
|
||||
.transport = ESP_LOCAL_CTRL_TRANSPORT_BLE,
|
||||
.transport_config = {
|
||||
.ble = & (protocomm_ble_config_t) {
|
||||
.device_name = SERVICE_NAME,
|
||||
.service_uuid = {
|
||||
/* LSB <---------------------------------------
|
||||
* ---------------------------------------> MSB */
|
||||
0x21, 0xd5, 0x3b, 0x8d, 0xbd, 0x75, 0x68, 0x8a,
|
||||
0xb4, 0x42, 0xeb, 0x31, 0x4a, 0x1e, 0x98, 0x3d
|
||||
.. code-block:: c
|
||||
|
||||
esp_local_ctrl_config_t config = {
|
||||
.transport = ESP_LOCAL_CTRL_TRANSPORT_BLE,
|
||||
.transport_config = {
|
||||
.ble = & (protocomm_ble_config_t) {
|
||||
.device_name = SERVICE_NAME,
|
||||
.service_uuid = {
|
||||
/* LSB <---------------------------------------
|
||||
* ---------------------------------------> MSB */
|
||||
0x21, 0xd5, 0x3b, 0x8d, 0xbd, 0x75, 0x68, 0x8a,
|
||||
0xb4, 0x42, 0xeb, 0x31, 0x4a, 0x1e, 0x98, 0x3d
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
.proto_sec = {
|
||||
.version = PROTOCOM_SEC0,
|
||||
.custom_handle = NULL,
|
||||
.sec_params = NULL,
|
||||
},
|
||||
.handlers = {
|
||||
/* User defined handler functions */
|
||||
.get_prop_values = get_property_values,
|
||||
.set_prop_values = set_property_values,
|
||||
.usr_ctx = NULL,
|
||||
.usr_ctx_free_fn = NULL
|
||||
},
|
||||
/* Maximum number of properties that may be set */
|
||||
.max_properties = 10
|
||||
};
|
||||
},
|
||||
.proto_sec = {
|
||||
.version = PROTOCOM_SEC0,
|
||||
.custom_handle = NULL,
|
||||
.sec_params = NULL,
|
||||
},
|
||||
.handlers = {
|
||||
/* User defined handler functions */
|
||||
.get_prop_values = get_property_values,
|
||||
.set_prop_values = set_property_values,
|
||||
.usr_ctx = NULL,
|
||||
.usr_ctx_free_fn = NULL
|
||||
},
|
||||
/* Maximum number of properties that may be set */
|
||||
.max_properties = 10
|
||||
};
|
||||
|
||||
/* Start esp_local_ctrl service */
|
||||
ESP_ERROR_CHECK(esp_local_ctrl_start(&config));
|
||||
/* Start esp_local_ctrl service */
|
||||
ESP_ERROR_CHECK(esp_local_ctrl_start(&config));
|
||||
|
||||
|
||||
Similarly for HTTPS transport:
|
||||
Initialization of the **esp_local_ctrl** service over HTTPS transport is performed as follows:
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ Over The Air Updates (OTA)
|
||||
OTA Process Overview
|
||||
--------------------
|
||||
|
||||
The OTA update mechanism allows a device to update itself based on data received while the normal firmware is running (for example, over Wi-Fi or Bluetooth.)
|
||||
The OTA update mechanism allows a device to update itself based on data received while the normal firmware is running (for example, over Wi-Fi, Bluetooth or Ethernet).
|
||||
|
||||
OTA requires configuring the :doc:`../../api-guides/partition-tables` of the device with at least two OTA app slot partitions (i.e., ``ota_0`` and ``ota_1``) and an OTA Data Partition.
|
||||
|
||||
|
||||
@ -8,41 +8,43 @@ ESP 本地控制
|
||||
|
||||
通过 ESP-IDF 的 ESP 本地控制 (**esp_local_ctrl**) 组件，可使用 HTTPS 或 BLE 协议控制 ESP 设备。通过一系列可配置的处理程序，该组件允许你对应用程序定义的读/写 **属性** 进行访问。
|
||||
|
||||
通过 BLE 传输协议初始化 **esp_local_ctrl** 的过程如下：
|
||||
.. only:: SOC_BT_SUPPORTED
|
||||
|
||||
.. code-block:: c
|
||||
通过 BLE 传输协议初始化 **esp_local_ctrl** 的过程如下：
|
||||
|
||||
esp_local_ctrl_config_t config = {
|
||||
.transport = ESP_LOCAL_CTRL_TRANSPORT_BLE,
|
||||
.transport_config = {
|
||||
.ble = & (protocomm_ble_config_t) {
|
||||
.device_name = SERVICE_NAME,
|
||||
.service_uuid = {
|
||||
/* LSB <---------------------------------------
|
||||
* ---------------------------------------> MSB */
|
||||
0x21, 0xd5, 0x3b, 0x8d, 0xbd, 0x75, 0x68, 0x8a,
|
||||
0xb4, 0x42, 0xeb, 0x31, 0x4a, 0x1e, 0x98, 0x3d
|
||||
.. code-block:: c
|
||||
|
||||
esp_local_ctrl_config_t config = {
|
||||
.transport = ESP_LOCAL_CTRL_TRANSPORT_BLE,
|
||||
.transport_config = {
|
||||
.ble = & (protocomm_ble_config_t) {
|
||||
.device_name = SERVICE_NAME,
|
||||
.service_uuid = {
|
||||
/* LSB <---------------------------------------
|
||||
* ---------------------------------------> MSB */
|
||||
0x21, 0xd5, 0x3b, 0x8d, 0xbd, 0x75, 0x68, 0x8a,
|
||||
0xb4, 0x42, 0xeb, 0x31, 0x4a, 0x1e, 0x98, 0x3d
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
.proto_sec = {
|
||||
.version = PROTOCOM_SEC0,
|
||||
.custom_handle = NULL,
|
||||
.sec_params = NULL,
|
||||
},
|
||||
.handlers = {
|
||||
/* User defined handler functions */
|
||||
.get_prop_values = get_property_values,
|
||||
.set_prop_values = set_property_values,
|
||||
.usr_ctx = NULL,
|
||||
.usr_ctx_free_fn = NULL
|
||||
},
|
||||
/* Maximum number of properties that may be set */
|
||||
.max_properties = 10
|
||||
};
|
||||
},
|
||||
.proto_sec = {
|
||||
.version = PROTOCOM_SEC0,
|
||||
.custom_handle = NULL,
|
||||
.sec_params = NULL,
|
||||
},
|
||||
.handlers = {
|
||||
/* User defined handler functions */
|
||||
.get_prop_values = get_property_values,
|
||||
.set_prop_values = set_property_values,
|
||||
.usr_ctx = NULL,
|
||||
.usr_ctx_free_fn = NULL
|
||||
},
|
||||
/* Maximum number of properties that may be set */
|
||||
.max_properties = 10
|
||||
};
|
||||
|
||||
/* Start esp_local_ctrl service */
|
||||
ESP_ERROR_CHECK(esp_local_ctrl_start(&config));
|
||||
/* Start esp_local_ctrl service */
|
||||
ESP_ERROR_CHECK(esp_local_ctrl_start(&config));
|
||||
|
||||
|
||||
同样，对于 HTTP 传输：
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
OTA 流程概览
|
||||
------------
|
||||
|
||||
OTA 升级机制可以让设备在固件正常运行时根据接收数据（如通过 Wi-Fi 或蓝牙）进行自我更新。
|
||||
OTA 升级机制可以让设备在固件正常运行时根据接收数据（如通过 Wi-Fi、蓝牙或以太网）进行自我更新。
|
||||
|
||||
要运行 OTA 机制，需配置设备的 :doc:`../../api-guides/partition-tables`，该分区表至少包括两个 OTA 应用程序分区（即 ``ota_0`` 和 ``ota_1``）和一个 OTA 数据分区。
|
||||
|
||||
|
||||
@ -17,10 +17,6 @@ examples/protocols/esp_http_client:
|
||||
- if: INCLUDE_DEFAULT == 1 or IDF_TARGET == "linux"
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "linux"]
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4
|
||||
depends_filepatterns:
|
||||
- examples/common_components/protocol_examples_common/**/*
|
||||
- components/esp_http_client/**/*
|
||||
@ -28,10 +24,7 @@ examples/protocols/esp_http_client:
|
||||
examples/protocols/esp_local_ctrl:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: SOC_WIFI_SUPPORTED != 1
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: not supported on p4
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "esp32c3", "esp32s3"]
|
||||
reason: only test on these targets
|
||||
@ -42,20 +35,12 @@ examples/protocols/esp_local_ctrl:
|
||||
|
||||
examples/protocols/http_request:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
|
||||
examples/protocols/http_server:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "esp32c3", "esp32s3"]
|
||||
reason: only test on these targets
|
||||
@ -79,19 +64,13 @@ examples/protocols/http_server/captive_portal:
|
||||
examples/protocols/http_server/restful_server:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
depends_filepatterns:
|
||||
- examples/common_components/protocol_examples_common/**/*
|
||||
- components/esp_http_server/**/*
|
||||
|
||||
examples/protocols/http_server/ws_echo_server:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
@ -103,10 +82,6 @@ examples/protocols/https_mbedtls:
|
||||
<<: *default_dependencies
|
||||
enable:
|
||||
- if: INCLUDE_DEFAULT == 1 or IDF_TARGET == "linux"
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
@ -114,19 +89,15 @@ examples/protocols/https_mbedtls:
|
||||
examples/protocols/https_request:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: not supported on p4 and h2 # TODO: IDF-8076 (P4), IDF-9076 (H2)
|
||||
reason: not supported on h2 # TODO: IDF-9076 (H2)
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
|
||||
examples/protocols/https_server/simple:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "esp32c3", "esp32s3"]
|
||||
reason: only test on these targets
|
||||
@ -137,10 +108,6 @@ examples/protocols/https_server/simple:
|
||||
|
||||
examples/protocols/https_server/wss_server:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
@ -150,10 +117,6 @@ examples/protocols/https_server/wss_server:
|
||||
|
||||
examples/protocols/https_x509_bundle:
|
||||
<<: *default_dependencies
|
||||
disable:
|
||||
- if: IDF_TARGET == "esp32p4"
|
||||
temporary: true
|
||||
reason: not supported on p4 # TODO: IDF-8076
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: only test on esp32
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 | Linux |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | ----- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 | Linux |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | ----- |
|
||||
# ESP HTTP Client Example
|
||||
|
||||
See the README.md file in the upper level 'examples' directory for more information about examples.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# ESP Local Control using HTTPS server
|
||||
|
||||
|
||||
@ -2,19 +2,19 @@ menu "Example Configuration"
|
||||
|
||||
choice EXAMPLE_LOCAL_CTRL_TRANSPORT
|
||||
bool "Local Control Transport"
|
||||
default EXAMPLE_LOCAL_CTRL_TRANSPORT_BLE if !SOC_WIFI_SUPPORTED
|
||||
default EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
default EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
default EXAMPLE_LOCAL_CTRL_TRANSPORT_BLE if SOC_BT_SUPPORTED
|
||||
help
|
||||
Local Control component offers both, SoftAP and BLE transports. Choose any one.
|
||||
Local Control component offers both, HTTP/S and BLE transports. Choose any one.
|
||||
|
||||
config EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
bool "Soft AP"
|
||||
config EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
bool "HTTP/S"
|
||||
select LWIP_IPV4
|
||||
depends on SOC_WIFI_SUPPORTED
|
||||
|
||||
config EXAMPLE_LOCAL_CTRL_TRANSPORT_BLE
|
||||
bool "BLE"
|
||||
select BT_ENABLED
|
||||
depends on SOC_BT_SUPPORTED
|
||||
endchoice
|
||||
|
||||
choice EXAMPLE_PROTOCOMM_SECURITY_VERSION
|
||||
|
||||
@ -39,7 +39,7 @@ void app_main(void)
|
||||
}
|
||||
ESP_ERROR_CHECK(ret);
|
||||
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
ESP_ERROR_CHECK(esp_netif_init());
|
||||
ESP_ERROR_CHECK(esp_event_loop_create_default());
|
||||
|
||||
@ -47,7 +47,7 @@ void app_main(void)
|
||||
ESP_LOGI(TAG, "Connection failed, not starting esp_local_ctrl service");
|
||||
vTaskDelay(portMAX_DELAY);
|
||||
}
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP */
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP */
|
||||
|
||||
start_esp_local_ctrl_service();
|
||||
ESP_LOGI(TAG, "esp_local_ctrl service started");
|
||||
|
||||
@ -225,7 +225,7 @@ static void free_str(void *arg)
|
||||
/* Function used by app_main to start the esp_local_ctrl service */
|
||||
void start_esp_local_ctrl_service(void)
|
||||
{
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
#ifdef CONFIG_ESP_HTTPS_SERVER_ENABLE
|
||||
/* Set the configuration */
|
||||
httpd_ssl_config_t https_conf = HTTPD_SSL_CONFIG_DEFAULT();
|
||||
@ -262,7 +262,7 @@ void start_esp_local_ctrl_service(void)
|
||||
0xb4, 0x42, 0xeb, 0x31, 0x4a, 0x1e, 0x98, 0x3d,
|
||||
}
|
||||
};
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP */
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP */
|
||||
|
||||
#ifdef CONFIG_EXAMPLE_PROTOCOMM_SECURITY_VERSION_1
|
||||
/* What is the security level that we want (0, 1, 2):
|
||||
@ -306,7 +306,7 @@ void start_esp_local_ctrl_service(void)
|
||||
|
||||
#endif
|
||||
esp_local_ctrl_config_t config = {
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
.transport = ESP_LOCAL_CTRL_TRANSPORT_HTTPD,
|
||||
.transport_config = {
|
||||
#ifdef CONFIG_ESP_HTTPS_SERVER_ENABLE
|
||||
@ -320,7 +320,7 @@ void start_esp_local_ctrl_service(void)
|
||||
.transport_config = {
|
||||
.ble = ble_conf,
|
||||
},
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP */
|
||||
#endif /* CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP */
|
||||
.proto_sec = {
|
||||
.version = security,
|
||||
.custom_handle = NULL,
|
||||
@ -337,7 +337,7 @@ void start_esp_local_ctrl_service(void)
|
||||
.max_properties = 10
|
||||
};
|
||||
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_SOFTAP
|
||||
#ifdef CONFIG_EXAMPLE_LOCAL_CTRL_TRANSPORT_HTTP
|
||||
mdns_init();
|
||||
mdns_hostname_set(SERVICE_NAME);
|
||||
#endif
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
CONFIG_MDNS_PREDEF_NETIF_STA=n
|
||||
CONFIG_MDNS_PREDEF_NETIF_AP=n
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTP Request Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTP server advanced tests
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Async Requests Handlers HTTPD Server Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Simple HTTP File Server Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTPD Server Persistent Sockets Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTP Restful API Server Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Simple HTTPD Server Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Websocket echo server
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 | Linux |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | ----- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 | Linux |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | ----- |
|
||||
|
||||
# HTTP connection with TLS support using mbedTLS
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTPS Request Example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTP server with SSL support using OpenSSL
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTP Websocket server with SSL support
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# HTTPS x509 Bundle Example
|
||||
|
||||
|
||||
@ -140,9 +140,9 @@ examples/system/light_sleep:
|
||||
|
||||
examples/system/ota/advanced_https_ota:
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: target esp32h2, esp32p4 is not supported yet
|
||||
reason: target esp32h2 is not supported yet
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "esp32c3", "esp32s3"]
|
||||
temporary: true
|
||||
@ -161,9 +161,9 @@ examples/system/ota/advanced_https_ota:
|
||||
|
||||
examples/system/ota/native_ota_example:
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: target esp32h2, esp32p4 is not supported yet
|
||||
reason: target esp32h2 is not supported yet
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
reason: Only esp32 has ethernet runners
|
||||
@ -179,15 +179,15 @@ examples/system/ota/native_ota_example:
|
||||
|
||||
examples/system/ota/otatool:
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32c2", "esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: target esp32c2, esp32h2, esp32p4 is not supported yet
|
||||
reason: target esp32h2 is not supported yet
|
||||
|
||||
examples/system/ota/pre_encrypted_ota:
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: target esp32h2, esp32p4 is not supported yet
|
||||
reason: target esp32h2 is not supported yet
|
||||
disable_test:
|
||||
- if: IDF_TARGET != "esp32"
|
||||
temporary: true
|
||||
@ -204,9 +204,9 @@ examples/system/ota/pre_encrypted_ota:
|
||||
|
||||
examples/system/ota/simple_ota_example:
|
||||
disable:
|
||||
- if: IDF_TARGET in ["esp32h2", "esp32p4"]
|
||||
- if: IDF_TARGET in ["esp32h2"]
|
||||
temporary: true
|
||||
reason: target esp32h2, esp32p4 is not supported yet
|
||||
reason: target esp32h2 is not supported yet
|
||||
- if: CONFIG_NAME == "spiram" and SOC_SPIRAM_SUPPORTED != 1
|
||||
disable_test:
|
||||
- if: IDF_TARGET not in ["esp32", "esp32c3", "esp32s3"]
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Advanced HTTPS OTA example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Native OTA example
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# OTA Tool Example
|
||||
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
|
||||
# SPDX-License-Identifier: Unlicense OR CC0-1.0
|
||||
from __future__ import print_function
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
@ -15,6 +13,8 @@ from pytest_embedded import Dut
|
||||
@pytest.mark.esp32c3
|
||||
@pytest.mark.esp32s3
|
||||
@pytest.mark.esp32c6
|
||||
@pytest.mark.esp32c2
|
||||
@pytest.mark.esp32p4
|
||||
@pytest.mark.generic
|
||||
def test_otatool_example(dut: Dut) -> None:
|
||||
# Verify factory firmware
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Encrypted Binary OTA
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- |
|
||||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-P4 | ESP32-S2 | ESP32-S3 |
|
||||
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
|
||||
|
||||
# Simple OTA example
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user