Erhan Kurubas ad078c5153 semihosting: drop absolute path support 3 år sedan
..
asio 232b0eda5f [EXAMPLES/ASIO] Renames Kconfig parameter and clarify 3 år sedan
cbor 4c865baae4 managed components: fix version references to allow implicit updates according to semver 3 år sedan
coap_client 6127da32e4 Fixed the commented out coap_new_optlist() example in the coap_client example. 3 år sedan
coap_server 4c865baae4 managed components: fix version references to allow implicit updates according to semver 3 år sedan
esp_http_client 7059ea0895 esp_http_client example: Add cert for redirect to HTTPS example 3 år sedan
esp_local_ctrl 94056fd4a5 esp_https_server: API cleanup 3 år sedan
http2_request ba4e318e4c ci: Re-enable HTTP/2 request example test 3 år sedan
http_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 år sedan
http_server ad078c5153 semihosting: drop absolute path support 3 år sedan
https_mbedtls 3925365351 ci: Fix `pre-check` stage failing tests 3 år sedan
https_request 708e99497b global: add dependency on esp_timer component and include esp_timer.h 3 år sedan
https_server 8f77caa637 https_server: Fix example test failure 3 år sedan
https_x509_bundle 728a686b8a protocols: Updated examples to use correct API 3 år sedan
icmp_echo 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 3 år sedan
l2tap fcdb0306d0 examples: added ESP-NETIF L2 TAP example 3 år sedan
mdns 42ba8a8338 mdns: Fix copyright messages, update API descrition 3 år sedan
modbus 9fdf39651b freemodbus: remove component files from esp-idf (fix examples) 3 år sedan
mqtt 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 3 år sedan
slip 2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore 3 år sedan
smtp_client 44214a3028 smtp_client: Fixed garbage characters being printed 3 år sedan
sntp 965b8f0e62 examples/sntp: Document that SNTP-over-DHCP resets other NTP servers 3 år sedan
sockets 231ef90fc5 udp example:Optimization udp example with recv_msg 3 år sedan
static_ip 7ed8fdac59 esp_wifi: Always connect Station in PMF mode if possible 3 år sedan
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 år sedan

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.