Anton Maklakov d6a6ac4d2d Merge branch 'bugfix/mdns_example_test_graceful_fail' into 'master' 5 yıl önce
..
asio 15884eccf2 Add multi-target support for performance tests 6 yıl önce
cbor 5a09de8245 cbor: add tinycbor library and example 6 yıl önce
coap_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 yıl önce
coap_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 yıl önce
esp_http_client c7be363af9 Merge branch 'bugfix/http_client_example' into 'master' 5 yıl önce
esp_local_ctrl 4d9c573fb6 test, examples: use new component registration function 5 yıl önce
http2_request e27c495354 Fixed broken http2_request example. 5 yıl önce
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 yıl önce
http_server e57dbf7c27 http-server-example: correction of regex waiting to acquire IP address 5 yıl önce
https_mbedtls 947e3e94ed Add ESP certificate bundle feature 6 yıl önce
https_request 761c3a3942 examples: make sure WiFi interface is disabled when connecting with Ethernet 5 yıl önce
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 yıl önce
https_x509_bundle 3d57bf30a2 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost 5 yıl önce
icmp_echo 75cadc2e41 console: simplify examples 6 yıl önce
mdns 3758177bf8 mdns-example: fail gracefully if mdns response not received within timeout 5 yıl önce
modbus 3abdd2207d freemodbus: fix long buffer failure 5 yıl önce
mqtt 4d9c573fb6 test, examples: use new component registration function 5 yıl önce
openssl_client 405186c866 Added simple SMTP email client. 6 yıl önce
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 yıl önce
pppos_client 85e9930071 esp_modem: Fix misuse event_queue_size as pattern_queue_size 5 yıl önce
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 6 yıl önce
sntp 5b2fa1a5ad build_app: make multi target support readable 5 yıl önce
sockets 8a45f074fc esp-netif: Added API to get the underlying interface name 5 yıl önce
websocket 5288a797ef Fix format string in websocket example 5 yıl önce
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 yıl önce

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.