Angus Gratton 936523b904 Merge branch 'feature/secure_bootv2_c3' into 'master' %!s(int64=4) %!d(string=hai) anos
..
asio ec4de4fe5c example_tests: CI uses ECO0 for esp32c3 tests %!s(int64=4) %!d(string=hai) anos
cbor 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) %!s(int64=5) %!d(string=hai) anos
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) %!s(int64=5) %!d(string=hai) anos
esp_http_client f66bdf1233 esp_http_client: Enable support of crt_bundle in esp_http_client %!s(int64=4) %!d(string=hai) anos
esp_local_ctrl 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
http2_request b40df07521 http2_request/sh2lib: Modified the "sh2lib_connect" API to take in a new %!s(int64=4) %!d(string=hai) anos
http_request 4b7eaa1d1f http_request_example: Added example test %!s(int64=4) %!d(string=hai) anos
http_server 3874c20b5d esp_http_server: Fix examples parse ws keep-alive packet fail. %!s(int64=4) %!d(string=hai) anos
https_mbedtls a06dbc11a7 https_mbedtls_example: Add minimum free heap print in the example and %!s(int64=4) %!d(string=hai) anos
https_request d34acd0d82 examples/protocols: update www.howsmyssl.com certificate to fix test failures %!s(int64=5) %!d(string=hai) anos
https_server 3874c20b5d esp_http_server: Fix examples parse ws keep-alive packet fail. %!s(int64=4) %!d(string=hai) anos
https_x509_bundle 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
icmp_echo 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
mdns 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
modbus 0d3f19beea freemodbus: fix mb zero based reg address in the iterator %!s(int64=4) %!d(string=hai) anos
mqtt 98930e7be2 bugfix/mqtt examples: Updates the CA certificates used. %!s(int64=4) %!d(string=hai) anos
openssl_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) %!s(int64=5) %!d(string=hai) anos
openssl_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) %!s(int64=5) %!d(string=hai) anos
pppos_client 2610e9c22d Examples/esp_modem: Reset DCE pointer in DTE on failure %!s(int64=4) %!d(string=hai) anos
slip 74236f0b29 bugfix for ipv6_address_value_issue %!s(int64=5) %!d(string=hai) anos
smtp_client c2b5744ae7 Fixed content type of attachment %!s(int64=5) %!d(string=hai) anos
sntp 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
sockets 0c58d5fc6a lwip: added config option to enable LWIP_NETIF_API %!s(int64=4) %!d(string=hai) anos
websocket 0146f258d7 style: format python files with isort and double-quote-string-fixer %!s(int64=5) %!d(string=hai) anos
README.md 06711c7c36 examples: common connect component to use both interfaces at once %!s(int64=5) %!d(string=hai) anos

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.