esp-idf/examples/protocols
Harshit Malpani 3276054810 Merge branch 'feature/upgrade_components_version' into 'master'
Feature/upgrade components version

Closes IDF-6192

See merge request espressif/esp-idf!20965
2022-11-11 18:37:30 +08:00
..
cbor cbor: Update cbor component version in idf_component.yml file in example 2022-11-09 18:03:26 +05:30
coap_client
coap_server
esp_http_client fix: esp_http_client fix behaviour when disable_auto_redirect is enabled 2022-10-27 14:04:54 +05:30
esp_local_ctrl esp_local_ctrl: added sec1 and sec2 support in esp_local_ctrl example 2022-10-14 17:04:08 +05:30
http2_request
http_request
http_server
https_mbedtls
https_request Update pytest example for https_request to erase flash before start of test 2022-09-19 12:04:09 +05:30
https_server
https_x509_bundle ci: fix https_x509 example 2022-11-02 14:57:14 +05:30
icmp_echo doc: redirect console page 2022-11-02 14:21:57 +08:00
l2tap
modbus
mqtt partition: use esp_partition_munmap instead of spi_flash_munmap 2022-11-09 20:15:17 +08:00
mqtt5 ci: Fix mqtt broker is not available 2022-09-30 10:07:19 +08:00
smtp_client
sntp
sockets ci: Enable esp32c6 example, test_apps, and unit tests CI build stage 2022-11-01 11:23:21 +08:00
static_ip
.build-test-rules.yml ci: Enable esp32c6 example, test_apps, and unit tests CI build stage 2022-11-01 11:23:21 +08:00
README.md

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.