David Cermak d81482d699 mdns: Add asynchronous query API 4 anni fa
..
asio b3b71bc8ab CI: fix connection failures in asio example tests 4 anni fa
cbor 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
esp_http_client 24225e5c16 examples/esp_http_client: `output_buffer` isn't necessarily NUL-terminated 4 anni fa
esp_local_ctrl 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
http2_request b40df07521 http2_request/sh2lib: Modified the "sh2lib_connect" API to take in a new 4 anni fa
http_request f658e19d91 Add longer dut.expect timeout DNS -> 30s 4 anni fa
http_server 9e0c9e8551 restful_example: upgrade axios 4 anni fa
https_mbedtls a06dbc11a7 https_mbedtls_example: Add minimum free heap print in the example and 5 anni fa
https_request 02820a90f7 Add sdkconfig which disables all menuconfig options in mbedtls. 4 anni fa
https_server 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
https_x509_bundle 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
icmp_echo 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
mdns d81482d699 mdns: Add asynchronous query API 4 anni fa
modbus 0d3f19beea freemodbus: fix mb zero based reg address in the iterator 5 anni fa
mqtt 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
openssl_client 823abfdfd5 examples: Add esp-ssl example tests `server/client` 4 anni fa
openssl_server 823abfdfd5 examples: Add esp-ssl example tests `server/client` 4 anni fa
pppos_client fd47dd4bea Examples/PPPoS: Fix pppos SMS send potential timeout in prompt waiting 4 anni fa
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 anni fa
smtp_client c2b5744ae7 Fixed content type of attachment 5 anni fa
sntp 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 anni fa
sockets 07de534191 examples: Move non-block socket examples to a single app 4 anni fa
static_ip 9c9b96deff examples: Add a separate static_ip example 4 anni fa
websocket 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 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.