esp-idf/examples/protocols
Mahavir Jain 13a34affc6 Merge branch 'bugfix/fix_https_request_example' into 'master'
example: Updated https_request example to fail when time is not synced.

See merge request espressif/esp-idf!19701
2022-09-21 16:10:30 +08:00
..
cbor examples/cbor: keep newlib nano disabled in the example 2022-07-19 13:27:51 +05:30
coap_client example: Add coap_client example_test 2022-08-16 09:52:00 +05:30
coap_server coap: Update examples to use latest features of libcoap component 2022-07-28 13:11:52 +00:00
esp_http_client docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
esp_local_ctrl build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
http2_request docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
http_request docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
http_server tools: remove the dependency on the future package 2022-08-09 16:46:58 +02:00
https_mbedtls build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
https_request Update pytest example for https_request to erase flash before start of test 2022-09-19 12:04:09 +05:30
https_server esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
https_x509_bundle CI: make sure that reading of the ipv4 address has finished 2022-07-15 14:21:39 +08:00
icmp_echo build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
l2tap docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
modbus build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
mqtt mqtt/ssl_ds: Remove unwanted references to configure_ds.py, Also updated 2022-08-30 10:54:15 +05:30
mqtt5 build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
smtp_client docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
sntp CI: Improve common test methods 2022-07-15 14:21:34 +08:00
sockets Merge branch 'tcp_transport_client_example' into 'master' 2022-09-20 17:53:50 +08:00
static_ip docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
.build-test-rules.yml Merge branch 'examples/tcp_client_linux_support' into 'master' 2022-08-18 12:40:37 +08:00
README.md common_components: add wifi connect console commands 2022-07-15 01:16:27 +08:00

README.md

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.