Angus Gratton da4cb76f5a test: Refactor TFW load_source() method to only take the file path 6 lat temu
..
asio 3a19bf055d esp_netif and examples: using wifi driver handle, update examples and tests to pass the CI 6 lat temu
cbor 5a09de8245 cbor: add tinycbor library and example 6 lat temu
coap_client a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
coap_server a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
esp_http_client a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
esp_local_ctrl 6e0d274f58 esp_netif: example init code fixed to assert only variables, not 6 lat temu
http2_request a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
http_request a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
http_server da4cb76f5a test: Refactor TFW load_source() method to only take the file path 6 lat temu
https_mbedtls a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
https_request a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
https_server cf710a3cb1 esp_netif: include tcpip_adapter legacy header by default to provide *implicit* compatiblity 6 lat temu
icmp_echo c3ee156df0 ethernet: move netif glue && add ref counter 6 lat temu
mdns 19e24fe61e mdns: update mdns to use esp-netif for mdns supported services such as STA, AP, ETH 6 lat temu
modbus 4f9742d90c freemodbus: fix supported targets ci issue 6 lat temu
mqtt cf710a3cb1 esp_netif: include tcpip_adapter legacy header by default to provide *implicit* compatiblity 6 lat temu
openssl_client a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
openssl_server a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
pppos_client f27ae9b0e2 feature: Add uart hal support. 6 lat temu
sntp a49b934ef8 examples: protocol examples which use common connection component 6 lat temu
sockets ba13275c6b esp_netif: update default DHCP IP addresses to be in line with old interface, added loopback implementation, explicit esp-netif init, sanity checks for parameters added 6 lat temu
websocket a49b934ef8 examples: protocol examples which use common connection component 6 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.