Domů Procházet Nápověda
Přihlásit se
RT-Thread-packages
/
esp-idf
zrcadlo https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: v4.2.3
Větve Značky
esp-idf
/
examples
/
protocols
Vikram Dattu 3af5f20da1 Added support for security1 in local control před 4 roky
..
asio c26317ac90 CI: fix connection failures in asio example tests před 4 roky
cbor 5f024e1cd4 Add protocol example tests před 5 roky
coap_client 7dbf01afad coap: move mbedTLS config options from component to examples před 5 roky
coap_server 7dbf01afad coap: move mbedTLS config options from component to examples před 5 roky
esp_http_client 9b0132387e Update example test for esp_http_client před 4 roky
esp_local_ctrl 3af5f20da1 Added support for security1 in local control před 4 roky
http2_request e27c495354 Fixed broken http2_request example. před 5 roky
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() před 6 roky
http_server fa270d72c7 ci: using python3 to tun target test před 4 roky
https_mbedtls 947e3e94ed Add ESP certificate bundle feature před 6 roky
https_request 761c3a3942 examples: make sure WiFi interface is disabled when connecting with Ethernet před 5 roky
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() před 6 roky
https_x509_bundle 3d57bf30a2 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost před 5 roky
icmp_echo 8c4839e9e6 CI: change icmp example test address před 5 roky
mdns e95f97d40e mdns test: Add test to resolve esp32 hostname with DiG před 5 roky
modbus c4fe55d42a Revert "ci: temporarily disable RS485 related tests" před 5 roky
mqtt 33416006d3 bugfix/mqtt examples: Updates the CA certificates used. před 4 roky
openssl_client 405186c866 Added simple SMTP email client. před 6 roky
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() před 6 roky
pppos_client bcb1086410 docs: fixed dead readme link před 4 roky
smtp_client 1aac3c64b5 Updated the root certificate of https examples před 4 roky
sntp 6e7a091e39 Fix SNTP example test to match pattern před 5 roky
sockets 07596559dd CI/socket examples: Add UDP operation retries, wait until server is up před 4 roky
websocket 660f41772c ci: Fix websocket example test error handling před 5 roky
README.md 06711c7c36 examples: common connect component to use both interfaces at once před 5 roky

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.