Armando 6f412393b6 change(ci): add todo to p4 build test enable před 2 roky
..
esp_http_client ebc118b24d fix: Fixed following issues in esp_http_client examples před 2 roky
esp_local_ctrl ec39de3992 change(esp_prov): also remove print_function from esp_prov před 2 roky
http_request 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
http_server 6edd1be973 Examples/http-server: Make DNS server a simple configurable component před 2 roky
https_mbedtls e72061695e all: Removes unnecessary newline character in logs před 2 roky
https_request ea3bb21cf7 fix(esp-tls): fix the certificate check failure logging for cert bundle case před 2 roky
https_server 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
https_x509_bundle 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
icmp_echo 9aa23a4320 ci(wifi): add more wifi runners před 2 roky
l2tap e72061695e all: Removes unnecessary newline character in logs před 2 roky
linux_stubs b2af4d9689 lwip/linux: Add lwip support for networking component under linux před 2 roky
modbus 2c7ea7f819 examples: modbus add support for target esp32h2 před 2 roky
mqtt 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
mqtt5 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
smtp_client 4778d9b477 protocols/examples: Disable Wifi connection if not supported před 2 roky
sntp 7294438329 sntp/test: Fixed flaky example test před 3 roky
sockets 7dbd3f6909 feat(ci): Enable p4 example, test_apps and unit tests CI build před 2 roky
static_ip c07d237ffe examples: enable build esp32c6 for wifi and network examples před 3 roky
.build-test-rules.yml 6f412393b6 change(ci): add todo to p4 build test enable před 2 roky
README.md bf0e4943be common_components: add wifi connect console commands před 3 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/include/protocol_examples_common.h, 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.