Jiang Jiang Jian 233dc30fb1 Merge branch 'bugfix/pppos_event_deinit_exit_ppp_v4.3' into 'release/v4.3' 4 jaren geleden
..
asio 94a54d574b CI: fix connection failures in asio example tests 4 jaren geleden
cbor 0146f258d7 style: format python files with isort and double-quote-string-fixer 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 222f48367f Update example test for esp_http_client 4 jaren geleden
esp_local_ctrl 9e00034ec7 Added support for security1 in local control 4 jaren geleden
http2_request 64e543ed0a http2_request: Enable insecure TLS by default 5 jaren geleden
http_request 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
http_server 04df1f3a42 CI: enable example builds for C3 4 jaren geleden
https_mbedtls 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 jaren geleden
https_request ee409e042a Updated the root certificate of https examples 4 jaren geleden
https_server 04df1f3a42 CI: enable example builds for C3 4 jaren geleden
https_x509_bundle 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 jaren geleden
icmp_echo 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 jaren geleden
mdns 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 jaren geleden
modbus 5b52358092 freemodbus: check/fix reinitialization issues (tcp master and slave examples) 4 jaren geleden
mqtt d5e2a482c3 bugfix/mqtt examples: Updates the CA certificates used. 4 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 2e8b419b7a Examples/PPPoS: Add mandatory delay after +++ command 4 jaren geleden
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 jaren geleden
smtp_client ee409e042a Updated the root certificate of https examples 4 jaren geleden
sntp 0146f258d7 style: format python files with isort and double-quote-string-fixer 5 jaren geleden
sockets 9d72bdda58 asio coap: If LWIP IPV6 is disabled, automatically don't build asio & coap 4 jaren geleden
websocket 0146f258d7 style: format python files with isort and double-quote-string-fixer 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.