Startsida Utforska Hjälp
Logga in
RT-Thread-packages
/
esp-idf
spegling av https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Filer Ärenden 0 Wiki
Träd: 1c4d4752b3
Grenar Taggar
esp-idf
/
examples
/
protocols
David Čermák f8b649baaf Merge branch 'bugfix/ws_server_async_send_fin' into 'master' 5 år sedan
..
asio 15884eccf2 Add multi-target support for performance tests 6 år sedan
cbor 5f024e1cd4 Add protocol example tests 5 år sedan
coap_client 7dbf01afad coap: move mbedTLS config options from component to examples 5 år sedan
coap_server 7dbf01afad coap: move mbedTLS config options from component to examples 5 år sedan
esp_http_client 40f5ac4cd4 ci: Temporarily remove the esp_http_client httpbin redirect tests 5 år sedan
esp_local_ctrl 5f024e1cd4 Add protocol example tests 5 år sedan
http2_request e27c495354 Fixed broken http2_request example. 5 år sedan
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 år sedan
http_server f8b649baaf Merge branch 'bugfix/ws_server_async_send_fin' into 'master' 5 år sedan
https_mbedtls 947e3e94ed Add ESP certificate bundle feature 6 år sedan
https_request 761c3a3942 examples: make sure WiFi interface is disabled when connecting with Ethernet 5 år sedan
https_server 6673407f98 httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible 5 år sedan
https_x509_bundle 3d57bf30a2 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost 5 år sedan
icmp_echo 29f8aecfc0 console_repl: change config structure to support different devices 5 år sedan
mdns a4d0033c03 esp_rom: extract common GPIO apis into esp_rom_gpio.h 5 år sedan
modbus 983220e216 ci: temporarily disable RS485 related tests 5 år sedan
mqtt 4d9c573fb6 test, examples: use new component registration function 5 år sedan
openssl_client 405186c866 Added simple SMTP email client. 6 år sedan
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 6 år sedan
pppos_client a80cff924b docs: fix broken links in example READMEs 5 år sedan
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 6 år sedan
sntp 1f05da9cfa Fix SNTP example test to match pattern 5 år sedan
sockets a80cff924b docs: fix broken links in example READMEs 5 år sedan
websocket 5288a797ef Fix format string in websocket example 5 år sedan
README.md 06711c7c36 examples: common connect component to use both interfaces at once 5 år sedan

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.