Angus Gratton 62426a6c90 Merge branch 'refactor/use_new_component_registration_functions' into 'master' 5 lat temu
..
asio 15884eccf2 Add multi-target support for performance tests 5 lat temu
cbor 5a09de8245 cbor: add tinycbor library and example 6 lat temu
coap_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
coap_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
esp_http_client b9555db47f examples: Add example to demonstrate use of low level APIs for GET and POST requests 5 lat temu
esp_local_ctrl 4d9c573fb6 test, examples: use new component registration function 5 lat temu
http2_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
http_server 0c13082b20 http_server docs: document websocket feature and corresponding example 5 lat temu
https_mbedtls 947e3e94ed Add ESP certificate bundle feature 6 lat temu
https_request 15884eccf2 Add multi-target support for performance tests 5 lat temu
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
https_x509_bundle 4d9c573fb6 test, examples: use new component registration function 5 lat temu
icmp_echo 75cadc2e41 console: simplify examples 6 lat temu
mdns 15884eccf2 Add multi-target support for performance tests 5 lat temu
modbus ba1ee4092a freemodbus: fix merge issues 6 lat temu
mqtt 4d9c573fb6 test, examples: use new component registration function 5 lat temu
openssl_client 405186c866 Added simple SMTP email client. 6 lat temu
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 lat temu
pppos_client fffdc1d789 esp-netif-ppp: support for setting ppp netif up and down 5 lat temu
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 6 lat temu
sntp 8bc618f070 Merge branch 'feature/sntp_add_desc' into 'master' 6 lat temu
sockets a5a750ba48 examples: add socket stdin utils to common connect component 5 lat temu
websocket 15884eccf2 Add multi-target support for performance tests 5 lat temu
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands 6 lat temu

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 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 or Ethernet connection, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" 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.