Chen Yudong fa270d72c7 ci: using python3 to tun target test 4 anni fa
..
asio 15884eccf2 Add multi-target support for performance tests 5 anni fa
cbor 5f024e1cd4 Add protocol example tests 5 anni fa
coap_client 7dbf01afad coap: move mbedTLS config options from component to examples 5 anni fa
coap_server 7dbf01afad coap: move mbedTLS config options from component to examples 5 anni fa
esp_http_client 0dedf0e1f5 examples/protocols: update www.howsmyssl.com certificate to fix test failures 5 anni fa
esp_local_ctrl 1ef10dc284 esp_wifi: Modify ESP_IF_WIFI_STA to WIFI_IF_STA 4 anni fa
http2_request e27c495354 Fixed broken http2_request example. 5 anni fa
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 anni fa
http_server fa270d72c7 ci: using python3 to tun target test 4 anni fa
https_mbedtls 947e3e94ed Add ESP certificate bundle feature 5 anni fa
https_request 761c3a3942 examples: make sure WiFi interface is disabled when connecting with Ethernet 5 anni fa
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 anni fa
https_x509_bundle 3d57bf30a2 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost 5 anni fa
icmp_echo 8c4839e9e6 CI: change icmp example test address 5 anni fa
mdns e95f97d40e mdns test: Add test to resolve esp32 hostname with DiG 5 anni fa
modbus c4fe55d42a Revert "ci: temporarily disable RS485 related tests" 4 anni fa
mqtt 4d9c573fb6 test, examples: use new component registration function 5 anni fa
openssl_client 405186c866 Added simple SMTP email client. 6 anni fa
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 anni fa
pppos_client 8cd16b60f5 Merge branch 'bugfix/ppp_deinit_failure_v4.2' into 'release/v4.2' 5 anni fa
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 6 anni fa
sntp 6e7a091e39 Fix SNTP example test to match pattern 5 anni fa
sockets fa270d72c7 ci: using python3 to tun target test 4 anni fa
websocket 660f41772c ci: Fix websocket example test error handling 5 anni fa
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 anni fa

README.md

Protocols Examples

Implementation of internet communication protocols and services.

See the README.md file in the upper level examples directory for more information about examples.

Establishing Wi-Fi or Ethernet Connection

About the example_connect() Function

Protocols examples use a simple helper function, example_connect(), to establish Wi-Fi and/or Ethernet connection. This function is implemented in examples/common_components/protocol_examples/common/connect.c, and has a very simple behavior: block until connection is established and IP address is obtained, then return. This function is used to reduce the amount of boilerplate and to keep the example code focused on the protocol or library being demonstrated.

The simple example_connect() function does not handle timeouts, does not gracefully handle various error conditions, and is only suited for use in examples. When developing real applications, this helper function needs to be replaced with full Wi-Fi / Ethernet connection handling code. Such code can be found in examples/wifi/getting_started/ and examples/ethernet/basic/ examples.

Configuring the Example

To configure the example to use Wi-Fi, Ethernet or both connections, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" or both in the "Connect using" choice.

When connecting using Wi-Fi, enter SSID and password of your Wi-Fi access point into the corresponding fields. If connecting to an open Wi-Fi network, keep the password field empty.

When connecting using Ethernet, set up PHY type and configuration in the provided fields. If using Ethernet for the first time, it is recommended to start with the Ethernet example readme, which contains instructions for connecting and configuring the PHY. Once Ethernet example obtains IP address successfully, proceed to the protocols example and set the same configuration options.

Disabling IPv6

By default, example_connect() function waits until Wi-Fi or Ethernet connection is established, and IPv4 address and IPv6 link-local address are obtained. In network environments where IPv6 link-local address cannot be obtained, disable "Obtain IPv6 link-local address" option found in "Example Connection Configuration" menu.