Aditya Patwardhan 6a7e15d019 Disable the example test for http2 request example. пре 4 година
..
asio b3b71bc8ab CI: fix connection failures in asio example tests пре 4 година
cbor 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) пре 5 година
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) пре 5 година
esp_http_client 24225e5c16 examples/esp_http_client: `output_buffer` isn't necessarily NUL-terminated пре 4 година
esp_local_ctrl 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
http2_request 6a7e15d019 Disable the example test for http2 request example. пре 4 година
http_request f658e19d91 Add longer dut.expect timeout DNS -> 30s пре 4 година
http_server 9e0c9e8551 restful_example: upgrade axios пре 4 година
https_mbedtls a06dbc11a7 https_mbedtls_example: Add minimum free heap print in the example and пре 4 година
https_request 02820a90f7 Add sdkconfig which disables all menuconfig options in mbedtls. пре 4 година
https_server 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
https_x509_bundle 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
icmp_echo 3aa9ac2469 usb_serial_jtag: Add blocking driver to support vfs. пре 4 година
mdns 042fa1831e CI: mdns example test: start responder after valid IP пре 4 година
modbus 0d3f19beea freemodbus: fix mb zero based reg address in the iterator пре 4 година
mqtt 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
openssl_client 823abfdfd5 examples: Add esp-ssl example tests `server/client` пре 4 година
openssl_server 823abfdfd5 examples: Add esp-ssl example tests `server/client` пре 4 година
pppos_client fd47dd4bea Examples/PPPoS: Fix pppos SMS send potential timeout in prompt waiting пре 4 година
slip 74236f0b29 bugfix for ipv6_address_value_issue пре 5 година
smtp_client c2b5744ae7 Fixed content type of attachment пре 5 година
sntp 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
sockets 07de534191 examples: Move non-block socket examples to a single app пре 4 година
static_ip 9c9b96deff examples: Add a separate static_ip example пре 4 година
websocket 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols пре 4 година
README.md 06711c7c36 examples: common connect component to use both interfaces at once пре 5 година

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/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.