esp-idf/examples/protocols
Michael (XIAO Xufeng) 47c153b949 Merge branch 'ci/pre-commit-check-build-test-rule-exist' into 'master'
pre-commit: add check that build-test-rule paths must exist

See merge request espressif/esp-idf!25231
2023-08-17 02:25:45 +08:00
..
esp_http_client fix: Fixed following issues in esp_http_client examples 2023-07-24 12:17:28 +05:30
esp_local_ctrl change(esp_prov): also remove print_function from esp_prov 2023-07-19 21:05:30 +08:00
http_request protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
http_server Examples/http-server: Make DNS server a simple configurable component 2023-06-07 08:46:24 +02:00
https_mbedtls all: Removes unnecessary newline character in logs 2023-06-09 03:31:21 +08:00
https_request fix(esp-tls): fix the certificate check failure logging for cert bundle case 2023-08-11 17:27:01 +05:30
https_server protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
https_x509_bundle protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
icmp_echo ci(wifi): add more wifi runners 2023-07-24 18:09:55 +08:00
l2tap all: Removes unnecessary newline character in logs 2023-06-09 03:31:21 +08:00
linux_stubs/esp_stubs lwip/linux: Add lwip support for networking component under linux 2023-05-05 05:03:39 +00:00
modbus examples: modbus add support for target esp32h2 2023-06-21 09:53:02 +02:00
mqtt protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
mqtt5 protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
smtp_client protocols/examples: Disable Wifi connection if not supported 2023-05-30 13:26:45 +02:00
sntp sntp/test: Fixed flaky example test 2023-02-01 08:01:54 +01:00
sockets ci(wifi): add more wifi runners 2023-07-24 18:09:55 +08: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(pre-commit): add check that build-test-rule paths must exist 2023-08-11 17:04:35 +08:00
README.md common_components: add wifi connect console commands 2022-07-15 01:16:27 +08:00

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.