Alex Lisitsyn cd27a44107 Merge branch 'bugfix/modbus_fix_stack_reinitialization_sequence' into 'master' 4 년 전
..
asio a06357ab62 examples: Asio tests consolidation to use loopback interface 4 년 전
cbor 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 4 년 전
coap_client ed3d440428 libcoap_430: Update code for use with libcoap 4.3.0 4 년 전
coap_server ed3d440428 libcoap_430: Update code for use with libcoap 4.3.0 4 년 전
esp_http_client 24225e5c16 examples/esp_http_client: `output_buffer` isn't necessarily NUL-terminated 4 년 전
esp_local_ctrl 5691c9a8e8 Added support for security1 in local control 4 년 전
http2_request 294b805f31 docs: Updated protocols/http* examples READMEs 4 년 전
http_request 294b805f31 docs: Updated protocols/http* examples READMEs 4 년 전
http_server 923e862ed2 ci: temporarily disable s3 build for a few examples 4 년 전
https_mbedtls 294b805f31 docs: Updated protocols/http* examples READMEs 4 년 전
https_request 88f9a6b90f Update README.md: Added information about session ticket feature 4 년 전
https_server 294b805f31 docs: Updated protocols/http* examples READMEs 4 년 전
https_x509_bundle 294b805f31 docs: Updated protocols/http* examples READMEs 4 년 전
icmp_echo 3aa9ac2469 usb_serial_jtag: Add blocking driver to support vfs. 4 년 전
mdns e5766eb3d3 Merge branch 'feature/mdns-async-callback' into 'master' 4 년 전
modbus c965b48e77 freemodbus: fix TCP stack/examples reinitialization sequence 4 년 전
mqtt 667017d517 ESP32S3 support for ESP-MQTT SSL Mutual Authentication with Digital Signature 4 년 전
openssl_client 823abfdfd5 examples: Add esp-ssl example tests `server/client` 4 년 전
openssl_server 823abfdfd5 examples: Add esp-ssl example tests `server/client` 4 년 전
pppos_client f0ecd70fd7 Examples/PPPoS: Warn about not supporting in v5.0 4 년 전
slip 74236f0b29 bugfix for ipv6_address_value_issue 5 년 전
smtp_client c2b5744ae7 Fixed content type of attachment 5 년 전
sntp 34be62665c lwip: menuconfig option to enable ntp servers option request via DHCP 4 년 전
sockets 07de534191 examples: Move non-block socket examples to a single app 4 년 전
static_ip 1b68ad93ad example: Add DNS configure and test for static ip example 4 년 전
websocket 0a395134d4 Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols 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.