Liu Han b3a35e3d4e pppos-client: Refactor modem component 5 سال پیش
..
asio 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
cbor 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
esp_http_client d34acd0d82 examples/protocols: update www.howsmyssl.com certificate to fix test failures 5 سال پیش
esp_local_ctrl 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
http2_request 64e543ed0a http2_request: Enable insecure TLS by default 5 سال پیش
http_request 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
http_server cd521d4ae3 esp_http_server: support dynamic payload len for ws server 5 سال پیش
https_mbedtls 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
https_request d34acd0d82 examples/protocols: update www.howsmyssl.com certificate to fix test failures 5 سال پیش
https_server cd521d4ae3 esp_http_server: support dynamic payload len for ws server 5 سال پیش
https_x509_bundle 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
icmp_echo 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
mdns 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
modbus 0d3f19beea freemodbus: fix mb zero based reg address in the iterator 4 سال پیش
mqtt ca037eba9b examples: Update mqtt open source test server address 5 سال پیش
openssl_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
openssl_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 سال پیش
pppos_client b3a35e3d4e pppos-client: Refactor modem component 4 سال پیش
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 سال پیش
smtp_client c2b5744ae7 Fixed content type of attachment 5 سال پیش
sntp 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
sockets f8d27ebd76 examples: Make tcp_server example support tcp keepalive function 5 سال پیش
websocket 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 سال پیش
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.