esp-idf/examples/protocols
David Cermak e99490a0dd CI: Fix example test for http_request
Test is based on a public http server which might not be always
available, so the example test checks if it's available
so the test could be (by)passed if the public server not available.

But we didn't correctly check if a socket/timeout exception occurs
when trying to connect
2021-11-04 17:02:36 +01:00
..
asio example_tests: Deletes usage esp32c3 ECO0 in CI (by default ECO3) 2021-09-24 13:55:07 +08: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 libcoap_430: Update code for use with libcoap 4.3.0 2021-08-31 12:05:30 +08:00
coap_server libcoap_430: Update code for use with libcoap 4.3.0 2021-08-31 12:05:30 +08:00
esp_http_client esp_http_client: Support handling larger content lengths 2021-10-29 18:14:22 +08:00
esp_local_ctrl Added support for security1 in local control 2021-08-26 17:35:09 +08:00
http2_request CI: Fix example test for http_request 2021-11-04 17:02:36 +01:00
http_request [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
http_server ci: temporarily disable s3 build for a few examples 2021-09-16 12:20:11 +08:00
https_mbedtls [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
https_request Updated the root certificate of https examples 2021-10-01 13:02:48 +05:30
https_server feature: Added user callback for esp_https_server 2021-10-11 09:41:01 +05:30
https_x509_bundle docs: Updated protocols/http* examples READMEs 2021-09-13 09:55:19 +05:30
icmp_echo [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
mdns mdns: support service subtype 2021-10-19 17:54:17 +08:00
modbus Bugfix/modbus fix copyright headers 2021-10-23 01:23:03 +08:00
mqtt ESP32S3 support for ESP-MQTT SSL Mutual Authentication with Digital Signature 2021-09-06 11:17:30 +05:30
pppos_client Merge branch 'bugfix/pppos_client_dce_deref' into 'master' 2021-10-05 12:52:47 +00:00
slip/slip_udp bugfix for ipv6_address_value_issue 2020-11-13 08:55:32 +00:00
smtp_client Updated the root certificate of https examples 2021-10-01 13:02:48 +05:30
sntp lwip: menuconfig option to enable ntp servers option request via DHCP 2021-08-02 01:21:35 +03:00
sockets [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
static_ip example: Add DNS configure and test for static ip example 2021-07-21 14:46:59 +08:00
websocket [examples]: removed hyphens 2021-10-09 13:58:24 +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.