esp-idf/examples/protocols
Suren Gabrielyan cbc767b6d7 Merge branch 'bugfix/websocket_example_echo_server' into 'master'
websocket: Updated Kconfig to use 'echo.websocket.events' echo server

Closes IDFGH-6619

See merge request espressif/esp-idf!16965
2022-02-03 08:40:53 +00:00
..
asio EXAMPLE/ASIO Async HTTP request 2021-12-15 19:54:24 +08:00
cbor other: Move cbor, jsmn and libsodium to idf-component-manager 2021-11-30 21:44:48 +01:00
coap_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
coap_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_http_client esp_http_client: Added event for HTTP redirect 2022-01-12 11:40:32 +05:30
esp_local_ctrl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
http2_request examples: add sh2lib dependency on http2_request through component manager 2022-01-11 10:26:25 +05:30
http_request Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
http_server docs: Add user-friendly guide about how to use ws_server_example_test.py 2022-01-02 11:27:05 +00:00
https_mbedtls Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
https_request esp-tls: mark esp_tls_conn_delete API as deprecated 2022-01-04 15:40:07 +05:30
https_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
https_x509_bundle esp-tls: mark esp_tls_conn_delete API as deprecated 2022-01-04 15:40:07 +05:30
icmp_echo Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mdns ci/mdns: Run mdns test on ethernet runners 2022-01-14 14:35:06 +01:00
modbus freemodbus: allow address gaps in master data dictionary (support of UID field in MBAP) 2022-01-21 05:18:00 +00:00
mqtt configure_ds.py: Fix the error for prod mode. They script now only verifies the purpose in the prod mode. 2022-01-31 14:13:25 +05:30
slip/slip_udp Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
smtp_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
sntp Examples/lwip: sntp example - Make SNTP server configurable 2021-11-25 08:50:29 +01:00
sockets Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
static_ip Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
websocket websocket: Updated Kconfig to use 'echo.websocket.events' echo server 2022-01-27 17:10:15 +04:00
README.md examples: common connect component to use both interfaces at once 2020-05-18 09:26:24 +02:00

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.