esp-idf/examples/protocols
David Čermák 956e62c461 Merge branch 'feature/lwip_ipv6_only' into 'master'
lwip: Support IPv6 only mode

Closes IDF-6023

See merge request espressif/esp-idf!20468
2023-03-01 21:38:10 +08:00
..
coap_client lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
coap_server lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
esp_http_client Add test for Linux in pytest_esp_http_client.py 2023-02-27 15:12:15 +05:30
esp_local_ctrl lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
http2_request esp_netif/lwip: Fix core-locking config 2023-01-17 16:15:58 +01:00
http_request examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
http_server lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
https_mbedtls examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
https_request esp_netif/lwip: Fix core-locking config 2023-01-17 16:15:58 +01:00
https_server esp-tls: Add build test for server session ticket option 2023-02-24 04:45:23 +00:00
https_x509_bundle examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
icmp_echo examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
l2tap examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
linux_stubs/esp_stubs Add test for Linux in pytest_esp_http_client.py 2023-02-27 15:12:15 +05:30
modbus Merge branch 'feature/modbus_remove_example_tests' into 'master' 2023-02-28 19:50:26 +08:00
mqtt mqtt/ssl_ds: enable the example for ESP32-H2 target 2023-02-13 10:27:22 +05:30
mqtt5 examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
smtp_client examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
sntp sntp/test: Fixed flaky example test 2023-02-01 08:01:54 +01:00
sockets Merge branch 'feature/lwip_ipv6_only' into 'master' 2023-03-01 21:38:10 +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 Merge branch 'feature/modbus_remove_example_tests' into 'master' 2023-02-28 19:50:26 +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.