esp-idf/examples/protocols
Harshit Malpani 1b7d8fafc5
docs: Update restful server example README file
Closes https://github.com/espressif/esp-idf/issues/13230
2024-02-28 16:52:11 +05:30
..
esp_http_client docs: Update App Utils programming guide docs for ESP32P4 2024-02-23 12:33:11 +05:30
esp_local_ctrl feat: Update esp_local_ctrl example for ESP32P4 2024-02-23 12:33:11 +05:30
http_request docs: Update App Utils programming guide docs for ESP32P4 2024-02-23 12:33:11 +05:30
http_server docs: Update restful server example README file 2024-02-28 16:52:11 +05:30
https_mbedtls docs: Update App Utils programming guide docs for ESP32P4 2024-02-23 12:33:11 +05:30
https_request ci: fix ESP32-P4 build failures in CI 2024-02-26 22:59:01 +08:00
https_server docs: Update App Utils programming guide docs for ESP32P4 2024-02-23 12:33:11 +05:30
https_x509_bundle docs: Update App Utils programming guide docs for ESP32P4 2024-02-23 12:33:11 +05:30
icmp_echo feat(examples): add local components via idf_component.yml 2023-09-19 10:38:24 +02:00
l2tap ci(esp_eth): enable Ethernet tests 2024-01-22 09:30:24 +01:00
linux_stubs/esp_stubs lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
modbus ci(modbus): fixed modbus tcp_slave example build failure 2024-01-29 15:25:56 +08:00
mqtt feat(example): Use PPP config in one MQTT example 2023-10-30 14:50:03 +01:00
mqtt5 feat(examples): add local components via idf_component.yml 2023-09-19 10:38:24 +02:00
smtp_client feat(examples): add local components via idf_component.yml 2023-09-19 10:38:24 +02:00
sntp feat(examples): add local components via idf_component.yml 2023-09-19 10:38:24 +02:00
sockets build: bypass build issues 2024-01-10 15:34:50 +01:00
static_ip examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
.build-test-rules.yml ci: fix ESP32-P4 build failures in CI 2024-02-26 22:59:01 +08:00
README.md common_components: add wifi connect console commands 2022-07-15 01:16:27 +08:00

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.