Home Explore Help
Sign In
RT-Thread-packages
/
esp-idf
mirror of https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ff8d05466e
Branches Tags
esp-idf
/
examples
/
protocols
Cao Sen Miao 4065872a88 http_server: The example adds a new function about file saving to SDcard 5 years ago
..
asio b2150f86a5 asio: make the example code conform to Espressif C++ standards 5 years ago
cbor 5f024e1cd4 Add protocol example tests 5 years ago
coap_client 7dbf01afad coap: move mbedTLS config options from component to examples 5 years ago
coap_server 7dbf01afad coap: move mbedTLS config options from component to examples 5 years ago
esp_http_client 40f5ac4cd4 ci: Temporarily remove the esp_http_client httpbin redirect tests 5 years ago
esp_local_ctrl 5f024e1cd4 Add protocol example tests 5 years ago
http2_request e27c495354 Fixed broken http2_request example. 6 years ago
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 years ago
http_server 4065872a88 http_server: The example adds a new function about file saving to SDcard 5 years ago
https_mbedtls 947e3e94ed Add ESP certificate bundle feature 6 years ago
https_request 761c3a3942 examples: make sure WiFi interface is disabled when connecting with Ethernet 5 years ago
https_server 6f3fa81863 http_server: Simplified httpd_get_client_list() to return clients in int array 5 years ago
https_x509_bundle 3d57bf30a2 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost 5 years ago
icmp_echo 29f8aecfc0 console_repl: change config structure to support different devices 5 years ago
mdns 81e89476fe mdns test: Add test to resolve esp32 hostname with DiG 5 years ago
modbus 4941cf58d0 Revert "ci: temporarily disable RS485 related tests" 5 years ago
mqtt b5c2fa632d esp32s2/esp_ds: Added mqtt example for TLS using Digital Signature 5 years ago
openssl_client 405186c866 Added simple SMTP email client. 6 years ago
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 years ago
pppos_client 6f1b8fe062 esp-modem: Remove esp-netif destroy from modem network glue code 5 years ago
slip 5dae28069f esp-netif: Fix SLIP interface to start with correct IPv6 addr 5 years ago
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 6 years ago
sntp 1f05da9cfa Fix SNTP example test to match pattern 5 years ago
sockets a80cff924b docs: fix broken links in example READMEs 5 years ago
websocket 44c553fd14 ws_client tests: Updated example test to use WebsSocket package 5 years ago
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 years ago

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.