Mahavir Jain ca9f285782 Merge branch 'bugfix/smtp_client' into 'master' 3 ani în urmă
..
asio f7b842bbc7 EXAMPLES/ASIO: Adds a SOCKS4 example 4 ani în urmă
cbor 4c865baae4 managed components: fix version references to allow implicit updates according to semver 4 ani în urmă
coap_client 4c865baae4 managed components: fix version references to allow implicit updates according to semver 4 ani în urmă
coap_server 4c865baae4 managed components: fix version references to allow implicit updates according to semver 4 ani în urmă
esp_http_client 021f545f0d examples: add dependency on cert bundle configuration 3 ani în urmă
esp_local_ctrl 94056fd4a5 esp_https_server: API cleanup 4 ani în urmă
http2_request 3b1f1febc8 http2_request_example: Use esp_crt_bundle instead of hardcoded root 3 ani în urmă
http_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 ani în urmă
http_server 55fd823001 Merge branch 'contrib/github_pr_8523' into 'master' 4 ani în urmă
https_mbedtls 3925365351 ci: Fix `pre-check` stage failing tests 4 ani în urmă
https_request 021f545f0d examples: add dependency on cert bundle configuration 3 ani în urmă
https_server 8f77caa637 https_server: Fix example test failure 3 ani în urmă
https_x509_bundle 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 4 ani în urmă
icmp_echo 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 4 ani în urmă
l2tap fcdb0306d0 examples: added ESP-NETIF L2 TAP example 3 ani în urmă
mdns 42ba8a8338 mdns: Fix copyright messages, update API descrition 4 ani în urmă
modbus 980fd32f69 example/modbus_master: fix the assert for uart_set_pin 3 ani în urmă
mqtt 795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 4 ani în urmă
slip 2571aaf3c9 G0: target component (components/esp32*) doesn't depend on driver anymore 4 ani în urmă
smtp_client 44214a3028 smtp_client: Fixed garbage characters being printed 3 ani în urmă
sntp 965b8f0e62 examples/sntp: Document that SNTP-over-DHCP resets other NTP servers 3 ani în urmă
sockets 467e9c07d6 lwip: fix build with CONFIG_LWIP_DHCPS disabled 3 ani în urmă
static_ip 7ed8fdac59 esp_wifi: Always connect Station in PMF mode if possible 4 ani în urmă
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 ani în urmă

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.