esp-idf/examples/protocols
Angus Gratton 209a6cc855 Merge branch 'bugfix/check_partitions_fit' into 'master'
cmake partition_table: Check binaries fit in partition spaces at build time

Closes IDF-1539 and IDFGH-2503

See merge request espressif/esp-idf!9330
2021-04-19 07:33:36 +00:00
..
asio partition_table: Add a "single factory app (large)" option for 1.5MB app size 2021-04-16 16:40:47 +10:00
cbor Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
coap_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
coap_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
esp_http_client esp_http_client: Enable support of crt_bundle in esp_http_client 2021-04-07 05:31:21 +00:00
esp_local_ctrl Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
http2_request http2_request/sh2lib: Modified the "sh2lib_connect" API to take in a new 2021-04-09 10:24:15 +00:00
http_request http_request_example: Added example test 2021-03-16 09:55:01 +05:30
http_server restful_example: upgrade axios 2021-04-19 11:51:56 +08:00
https_mbedtls https_mbedtls_example: Add minimum free heap print in the example and 2021-03-16 17:15:56 +05:30
https_request examples/protocols: update www.howsmyssl.com certificate to fix test failures 2021-01-29 19:06:24 +05:30
https_server Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
https_x509_bundle Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
icmp_echo Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
mdns Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
modbus freemodbus: fix mb zero based reg address in the iterator 2021-02-25 15:17:45 +01:00
mqtt Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
openssl_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
openssl_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
pppos_client Examples/PPPoS: Fix pppos SMS send potential timeout in prompt waiting 2021-04-14 07:50:10 +02:00
slip/slip_udp bugfix for ipv6_address_value_issue 2020-11-13 08:55:32 +00:00
smtp_client Fixed content type of attachment 2020-11-10 11:57:20 +05:30
sntp Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
sockets Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00:00
static_ip examples: Add a separate static_ip example 2021-04-12 05:32:48 +00:00
websocket Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 2021-04-15 04:00:06 +00: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.