Aditya Patwardhan a191ca21d9 esp_local_ctrl: Increase timeout of first read to minimize test failures před 3 roky
..
asio 157247f98f asio: fix example for compatibility with C++20 před 3 roky
cbor facab8c5a7 tools: Increase the minimal supported CMake version to 3.16 před 3 roky
coap_client f7be540222 ci: partially enable example build for esp32c2 před 3 roky
coap_server f7be540222 ci: partially enable example build for esp32c2 před 3 roky
esp_http_client 83ace52a36 http examples pytest migration před 3 roky
esp_local_ctrl a191ca21d9 esp_local_ctrl: Increase timeout of first read to minimize test failures před 3 roky
http2_request 83ace52a36 http examples pytest migration před 3 roky
http_request 83ace52a36 http examples pytest migration před 3 roky
http_server 83ace52a36 http examples pytest migration před 3 roky
https_mbedtls e83f801462 Update examples README to include esp32c2 as supported device. před 3 roky
https_request e83f801462 Update examples README to include esp32c2 as supported device. před 3 roky
https_server 63ed429a49 fix(example): Fix wss_server_example not close socket před 3 roky
https_x509_bundle e83f801462 Update examples README to include esp32c2 as supported device. před 3 roky
icmp_echo f7be540222 ci: partially enable example build for esp32c2 před 3 roky
l2tap f7be540222 ci: partially enable example build for esp32c2 před 3 roky
mdns f7be540222 ci: partially enable example build for esp32c2 před 3 roky
modbus facab8c5a7 tools: Increase the minimal supported CMake version to 3.16 před 3 roky
mqtt 2dea0e833a ci: Fix `mqtt_qos1` example test failure před 3 roky
slip f7be540222 ci: partially enable example build for esp32c2 před 3 roky
smtp_client f7be540222 ci: partially enable example build for esp32c2 před 3 roky
sntp facab8c5a7 tools: Increase the minimal supported CMake version to 3.16 před 3 roky
sockets aa3ddbc3c6 Merge branch 'test/enable_c2_target_tests' into 'master' před 3 roky
static_ip f7be540222 ci: partially enable example build for esp32c2 před 3 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.