Accueil Explorer Aide
Connexion
RT-Thread-packages
/
esp-idf
miroir de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: 3bb41fd67e
Branches Tags
esp-idf
/
examples
/
protocols
Angus Gratton 1a8dc6f76b Merge branch 'bugfix/ws_example_text_send' into 'master' il y a 6 ans
..
asio c906e2afee test: update example and unit tests with new import roles: il y a 6 ans
cbor 5a09de8245 cbor: add tinycbor library and example il y a 6 ans
coap_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
coap_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
esp_http_client 0c21e677cc http_client: fix example test to expect -1 as content-len for chunked transfer il y a 6 ans
esp_local_ctrl 5c0cd9417d Docs: Encourage to used Python 3 il y a 6 ans
http2_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
http_server 5c0cd9417d Docs: Encourage to used Python 3 il y a 6 ans
https_mbedtls 947e3e94ed Add ESP certificate bundle feature il y a 6 ans
https_request 947e3e94ed Add ESP certificate bundle feature il y a 6 ans
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
https_x509_bundle 947e3e94ed Add ESP certificate bundle feature il y a 6 ans
icmp_echo 75cadc2e41 console: simplify examples il y a 6 ans
mdns c906e2afee test: update example and unit tests with new import roles: il y a 6 ans
modbus ba1ee4092a freemodbus: fix merge issues il y a 6 ans
mqtt 911be99054 mqtt-tests: migrate the publish-connection test from example-test to test-apps il y a 6 ans
openssl_client 405186c866 Added simple SMTP email client. il y a 6 ans
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
pppos_client eae8eaa55f esp-netif-ppp: support for posting GOT_IP event for IPv6 il y a 6 ans
smtp_client 8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example il y a 6 ans
sntp 8bc618f070 Merge branch 'feature/sntp_add_desc' into 'master' il y a 6 ans
sockets 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() il y a 6 ans
websocket e5650d1ed8 examples: websocket example to send textual data with esp_websocket_client_send_text() il y a 6 ans
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans

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 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 or Ethernet connection, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" 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.