Marius Vikhammer 04df1f3a42 CI: enable example builds for C3 5 år sedan
..
asio 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
cbor 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
coap_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
coap_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
esp_http_client d34acd0d82 examples/protocols: update www.howsmyssl.com certificate to fix test failures 5 år sedan
esp_local_ctrl 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
http2_request 64e543ed0a http2_request: Enable insecure TLS by default 5 år sedan
http_request 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
http_server 04df1f3a42 CI: enable example builds for C3 5 år sedan
https_mbedtls 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
https_request d34acd0d82 examples/protocols: update www.howsmyssl.com certificate to fix test failures 5 år sedan
https_server 04df1f3a42 CI: enable example builds for C3 5 år sedan
https_x509_bundle 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
icmp_echo 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
mdns 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
modbus 96b77a28b1 freemodbus: add support for list of area descriptors for each register area 5 år sedan
mqtt c6339d0b4c ci: Make the mqtt example test to send only portion of the partition 5 år sedan
openssl_client 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
openssl_server 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 år sedan
pppos_client 04df1f3a42 CI: enable example builds for C3 5 år sedan
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 år sedan
smtp_client c2b5744ae7 Fixed content type of attachment 5 år sedan
sntp 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
sockets 04df1f3a42 CI: enable example builds for C3 5 år sedan
websocket 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 år sedan
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 år sedan

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.