History

Krzysztof 660eb84da7 Correct links Closes https://github.com/espressif/esp-idf/issues/3723		2019-07-02 18:22:33 +08:00
..
asio	examples: use new component registration api	2019-06-21 19:53:29 +08:00
coap_client	examples: use new component registration api	2019-06-21 19:53:29 +08:00
coap_server	examples: use new component registration api	2019-06-21 19:53:29 +08:00
esp_http_client	examples: use new component registration api	2019-06-21 19:53:29 +08:00
http2_request	examples: use new component registration api	2019-06-21 19:53:29 +08:00
http_request	examples: use new component registration api	2019-06-21 19:53:29 +08:00
http_server	examples: use new component registration api	2019-06-21 19:53:29 +08:00
https_mbedtls	examples: use new component registration api	2019-06-21 19:53:29 +08:00
https_request	examples: use new component registration api	2019-06-21 19:53:29 +08:00
https_server	example/https_server: Add default sdkconfig	2019-06-25 23:43:35 +00:00
mdns	examples: use new component registration api	2019-06-21 19:53:29 +08:00
modbus_master	examples: use new component registration api	2019-06-21 19:53:29 +08:00
modbus_slave	examples: use new component registration api	2019-06-21 19:53:29 +08:00
mqtt	examples: use new component registration api	2019-06-21 19:53:29 +08:00
openssl_client	examples: use new component registration api	2019-06-21 19:53:29 +08:00
openssl_server	examples: use new component registration api	2019-06-21 19:53:29 +08:00
pppos_client	examples: use new component registration api	2019-06-21 19:53:29 +08:00
sntp	examples: use new component registration api	2019-06-21 19:53:29 +08:00
sockets	examples: use new component registration api	2019-06-21 19:53:29 +08:00
websocket	examples: use new component registration api	2019-06-21 19:53:29 +08:00
README.md	Correct links	2019-07-02 18:22:33 +08:00

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, run make menuconfig (or idf.py menuconfig if using CMake build system) 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.