Historia

Shubham Kulkarni 4f6e0c1d27 esp_http_client: Add config option for HTTP Digest auth		2021-03-23 11:58:35 +05:30
..
asio	ci: run Example_GENERIC for C3	2021-03-15 10:27:07 +08:00
cbor	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
coap_client	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
coap_server	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
esp_http_client	esp_http_client: Add config option for HTTP Digest auth	2021-03-23 11:58:35 +05:30
esp_local_ctrl	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
http2_request	http2_request_example: Added example test	2021-03-16 09:55:01 +05:30
http_request	http_request_example: Added example test	2021-03-16 09:55:01 +05:30
http_server	esp_http_server: Fix examples parse ws keep-alive packet fail.	2021-03-16 09:55:02 +05:30
https_mbedtls	https_mbedtls_example: Add minimum free heap print in the example and	2021-03-16 17:15:56 +05:30
https_request	examples/protocols: update www.howsmyssl.com certificate to fix test failures	2021-01-29 19:06:24 +05:30
https_server	esp_http_server: Fix examples parse ws keep-alive packet fail.	2021-03-16 09:55:02 +05:30
https_x509_bundle	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
icmp_echo	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
mdns	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
modbus	freemodbus: fix mb zero based reg address in the iterator	2021-02-25 15:17:45 +01:00
mqtt	examples: Update mqtt open source test server address	2021-02-23 15:29:07 +08:00
openssl_client	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
openssl_server	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
pppos_client	pppos-client: Refactor modem component	2021-03-01 17:10:48 +00:00
slip/slip_udp	bugfix for ipv6_address_value_issue	2020-11-13 08:55:32 +00:00
smtp_client	Fixed content type of attachment	2020-11-10 11:57:20 +05:30
sntp	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
sockets	lwip: added config option to enable LWIP_NETIF_API	2021-03-17 17:53:07 +00:00
websocket	style: format python files with isort and double-quote-string-fixer	2021-01-26 10:49:01 +08:00
README.md	examples: common connect component to use both interfaces at once	2020-05-18 09:26:24 +02:00

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.