esp-idf/examples/protocols
Jakob Hasse d7cceabbb4 Merge branch 'feature/upgrade_c_cxx_standards' into 'master'
build system: use C17 and C++2a by default

Closes IDF-1499, IDFGH-1788, IDFGH-2781, and IDFGH-7617

See merge request espressif/esp-idf!18371
2022-06-20 12:24:08 +08:00
..
asio asio: fix example for compatibility with C++20 2022-06-17 16:44:17 +02:00
cbor tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
coap_client ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
coap_server ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
esp_http_client http examples pytest migration 2022-06-03 16:00:52 +05:30
esp_local_ctrl wifi_provisioning: Update the APIs with reference to the new APIs from protocomm 2022-06-17 13:16:20 +00:00
http2_request http examples pytest migration 2022-06-03 16:00:52 +05:30
http_request http examples pytest migration 2022-06-03 16:00:52 +05:30
http_server http examples pytest migration 2022-06-03 16:00:52 +05:30
https_mbedtls Update examples README to include esp32c2 as supported device. 2022-06-03 15:31:05 +05:30
https_request Update examples README to include esp32c2 as supported device. 2022-06-03 15:31:05 +05:30
https_server fix(example): Fix wss_server_example not close socket 2022-06-20 03:01:38 +00:00
https_x509_bundle Update examples README to include esp32c2 as supported device. 2022-06-03 15:31:05 +05:30
icmp_echo ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
l2tap ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
mdns ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
modbus tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
mqtt ci: Fix mqtt_qos1 example test failure 2022-06-15 14:16:44 +05:30
slip/slip_udp ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
smtp_client ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
sntp tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
sockets Merge branch 'test/enable_c2_target_tests' into 'master' 2022-06-03 16:41:24 +08:00
static_ip ci: partially enable example build for esp32c2 2022-06-02 14:17:31 +08:00
README.md examples: common connect component to use both interfaces at once 2020-05-18 09:26:24 +02: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/connect.c, 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.