Liu Han 4c30995b88 esp-modem: prefix the crash issue both bg96 and sim800l in OVERALL mode 5 lat temu
..
asio 911cc3710b CI: fix connection failures in asio example tests 4 lat temu
cbor 5a09de8245 cbor: add tinycbor library and example 6 lat temu
coap_client edb84c19dd coap: move mbedTLS config options from component to examples 5 lat temu
coap_server edb84c19dd coap: move mbedTLS config options from component to examples 5 lat temu
esp_http_client 4cde8e7792 Update example test for esp_http_client 4 lat temu
esp_local_ctrl 4403af7267 esp_wifi: Modify ESP_IF_WIFI_STA to WIFI_IF_STA 4 lat temu
http2_request 369ef2e6a8 Fixed broken http2_request example. 4 lat temu
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
http_server 9a29375f7d ci: run target test with python3 4 lat temu
https_mbedtls 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
https_request ade8b8b7a0 Updated the root certificate of https examples 4 lat temu
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
icmp_echo f664527eb4 vfs: support vfs uart set line endings with specified uart number (release/v4.1) 5 lat temu
mdns fcfc04c42a mdns test: Add test to resolve esp32 hostname with DiG 5 lat temu
modbus 46d8dad2e1 Revert "ci: temporarily disable RS485 related tests" 5 lat temu
mqtt e0c2145cc7 bugfix/mqtt examples: Updates the CA certificates used. 4 lat temu
openssl_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
pppos_client 4c30995b88 esp-modem: prefix the crash issue both bg96 and sim800l in OVERALL mode 4 lat temu
sntp 8bc618f070 Merge branch 'feature/sntp_add_desc' into 'master' 6 lat temu
sockets 62d1f3f9ba backport bugfix lwip for v4.1 5 lat temu
websocket 10785bc1e4 ci: Fix websocket example test error handling 4 lat temu
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands 6 lat temu

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 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 or Ethernet connection, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" 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.