Harshit Malpani 5a51af523c https examples pytest migration před 3 roky
..
asio 232b0eda5f [EXAMPLES/ASIO] Renames Kconfig parameter and clarify před 4 roky
cbor 57e2e7a27c Migrate cbor example to pytest framework před 3 roky
coap_client 6127da32e4 Fixed the commented out coap_new_optlist() example in the coap_client example. před 3 roky
coap_server 4c865baae4 managed components: fix version references to allow implicit updates according to semver před 4 roky
esp_http_client 7059ea0895 esp_http_client example: Add cert for redirect to HTTPS example před 3 roky
esp_local_ctrl 63b1b1bd44 esp_local_ctrl example pytest migration před 3 roky
http2_request 0687daf2c8 kconfig: move remaining kconfig options out of target component před 3 roky
http_request 26a15058d3 Add sdkconfig.h to protocol/https* examples před 3 roky
http_server 2c56c6cad8 Updated coding style and added error logs před 3 roky
https_mbedtls 5a51af523c https examples pytest migration před 3 roky
https_request 5a51af523c https examples pytest migration před 3 roky
https_server 5a51af523c https examples pytest migration před 3 roky
https_x509_bundle 5a51af523c https examples pytest migration před 3 roky
icmp_echo 58db82c764 Update echo_example_main.c před 3 roky
l2tap fcdb0306d0 examples: added ESP-NETIF L2 TAP example před 4 roky
mdns 1a20b10fd3 Examples: common source for GPIO range in Kconfigs defined před 3 roky
modbus 1a20b10fd3 Examples: common source for GPIO range in Kconfigs defined před 3 roky
mqtt 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer před 4 roky
slip 2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore před 4 roky
smtp_client 44214a3028 smtp_client: Fixed garbage characters being printed před 4 roky
sntp 965b8f0e62 examples/sntp: Document that SNTP-over-DHCP resets other NTP servers před 4 roky
sockets 231ef90fc5 udp example:Optimization udp example with recv_msg před 3 roky
static_ip 7ed8fdac59 esp_wifi: Always connect Station in PMF mode if possible před 4 roky
README.md 06711c7c36 examples: common connect component to use both interfaces at once před 5 roky

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.