Roland Dobai 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
..
asio 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
cbor 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
coap_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
coap_server 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
esp_http_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
esp_local_ctrl 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
http2_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
http_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
http_server 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
https_mbedtls 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
https_request 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
https_server 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
https_x509_bundle 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
icmp_echo 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
mdns 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
modbus 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
mqtt 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
pppos_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
slip 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
smtp_client 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
sntp 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
sockets 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
static_ip 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
websocket 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system 4 년 전
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 년 전

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.