Shubham Kulkarni 60749b5483 esp_http_client example: Update example to demonstrate partial HTTP downloads 5 jaren geleden
..
asio a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
cbor 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
esp_http_client 60749b5483 esp_http_client example: Update example to demonstrate partial HTTP downloads 5 jaren geleden
esp_local_ctrl e2716690bc Merge branch 'fix/esp_local_ctrl_update_expired_cert' into 'master' 5 jaren geleden
http2_request 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
http_request 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
http_server a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
https_mbedtls 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
https_request a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
https_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
https_x509_bundle a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
icmp_echo e039a28821 console: support create REPL over USB CDC 5 jaren geleden
mdns a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
modbus 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
mqtt 0a933f66e3 Merge branch 'fix/https_server_mem_leak_for_error_ret' into 'master' 5 jaren geleden
openssl_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
openssl_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
pppos_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 jaren geleden
smtp_client c2b5744ae7 Fixed content type of attachment 5 jaren geleden
sntp 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
sockets a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
websocket a908174c06 test: remove fake binary size check in example test: 5 jaren geleden
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 jaren geleden

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.