Alex Lisitsyn e9cdb3e0d3 freemodbus: allow address gaps in master data dictionary (support of UID field in MBAP) 4 tahun lalu
..
asio 2433816b14 EXAMPLE/ASIO Async HTTP request 4 tahun lalu
cbor ebaca79557 other: Move cbor, jsmn and libsodium to idf-component-manager 4 tahun lalu
coap_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
coap_server 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
esp_http_client ca84d2d6c9 esp_http_client: Added event for HTTP redirect 4 tahun lalu
esp_local_ctrl 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
http2_request d90bd94788 examples: add sh2lib dependency on http2_request through component manager 4 tahun lalu
http_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
http_server 0c73f20afd docs: Add user-friendly guide about how to use ws_server_example_test.py 4 tahun lalu
https_mbedtls 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
https_request c26500cd5a esp-tls: mark esp_tls_conn_delete API as deprecated 4 tahun lalu
https_server 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
https_x509_bundle c26500cd5a esp-tls: mark esp_tls_conn_delete API as deprecated 4 tahun lalu
icmp_echo 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
mdns 96616b6056 ci/mdns: Run mdns test on ethernet runners 4 tahun lalu
modbus e9cdb3e0d3 freemodbus: allow address gaps in master data dictionary (support of UID field in MBAP) 4 tahun lalu
mqtt 51e222e71f ci/mqtt: Move mqtt example tests to ethernet runners 4 tahun lalu
slip 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
smtp_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
sntp 020047b0f9 Examples/lwip: sntp example - Make SNTP server configurable 4 tahun lalu
sockets 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
static_ip 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 tahun lalu
websocket 323622be64 ws_client: Optimize example test payloads and timeouts 4 tahun lalu
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 tahun lalu

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.