Historia

gabsuren 321481b459 mDNS: Fix example test in CI using retries		2022-10-26 06:06:14 +00:00
..
asio	CI: fix connection failures in asio example tests	2021-06-08 17:05:04 +08:00
cbor	Add protocol example tests	2020-05-19 12:17:32 +02:00
coap_client	coap: move mbedTLS config options from component to examples	2020-05-19 17:23:29 +05:30
coap_server	coap: move mbedTLS config options from component to examples	2020-05-19 17:23:29 +05:30
esp_http_client	Update example test for esp_http_client	2021-10-07 17:58:51 +05:30
esp_local_ctrl	Added support for security1 in local control	2021-12-09 15:26:14 +08:00
http2_request	Fixed broken http2_request example.	2020-03-23 05:16:40 +00:00
http_request	esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK()	2019-12-17 09:07:49 +01:00
http_server	ci: using python3 to tun target test	2021-04-26 06:35:42 +00:00
https_mbedtls	Add ESP certificate bundle feature	2020-03-04 10:51:43 +08:00
https_request	examples: make sure WiFi interface is disabled when connecting with Ethernet	2020-05-18 09:29:55 +02:00
https_server	esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK()	2019-12-17 09:07:49 +01:00
https_x509_bundle	feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost	2020-05-14 11:45:09 +00:00
icmp_echo	CI: change icmp example test address	2021-01-07 14:49:29 +08:00
mdns	mDNS: Fix example test in CI using retries	2022-10-26 06:06:14 +00:00
modbus/serial	example/modbus_master: fix the assert for uart_set_pin	2022-05-10 08:05:22 +00:00
mqtt	bugfix/mqtt examples: Updates the CA certificates used.	2021-06-24 13:57:49 +08:00
openssl_client	Added simple SMTP email client.	2020-02-04 18:13:28 +05:30
openssl_server	esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK()	2019-12-17 09:07:49 +01:00
pppos_client	docs: fixed dead readme link	2021-07-21 17:35:47 +08:00
smtp_client	Updated the root certificate of https examples	2021-10-07 17:54:06 +05:30
sntp	Fix SNTP example test to match pattern	2020-07-01 14:37:06 +02:00
sockets	CI/socket examples: Add UDP operation retries, wait until server is up	2021-07-19 14:58:20 +02:00
websocket	ci: Fix websocket example test error handling	2021-02-09 06:59:56 +00: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.