Startseite Erkunden Hilfe
Anmelden
RT-Thread-packages
/
esp-idf
Mirror von https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: eda9d8ffa8
Branches Tags
esp-idf
/
examples
/
protocols
Angus Gratton 2241dda536 Merge branch 'feature/netif_ppp_authtype_none_v4.1' into 'release/v4.1' vor 5 Jahren
..
asio c906e2afee test: update example and unit tests with new import roles: vor 6 Jahren
cbor 5a09de8245 cbor: add tinycbor library and example vor 6 Jahren
coap_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
coap_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
esp_http_client 7261e72ef7 http_client: fix example test to expect -1 as content-len for chunked transfer vor 6 Jahren
esp_local_ctrl de3eed647f Docs: Encourage to used Python 3 vor 6 Jahren
http2_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
http_request 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
http_server de3eed647f Docs: Encourage to used Python 3 vor 6 Jahren
https_mbedtls 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
https_request 563175d90a mbedtls: Use SPIRAM strategy in example_test.py vor 6 Jahren
https_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
icmp_echo 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
mdns c906e2afee test: update example and unit tests with new import roles: vor 6 Jahren
modbus ba1ee4092a freemodbus: fix merge issues vor 6 Jahren
mqtt 30372f5a4f Merge branch 'docs/esp_netif_programmer_manual' into 'master' vor 6 Jahren
openssl_client 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
openssl_server 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
pppos_client 2241dda536 Merge branch 'feature/netif_ppp_authtype_none_v4.1' into 'release/v4.1' vor 5 Jahren
sntp 8bc618f070 Merge branch 'feature/sntp_add_desc' into 'master' vor 6 Jahren
sockets 31b2702387 esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() vor 6 Jahren
websocket ffeda3003c tcp_transport/ws_client: websockets now correctly handle messages longer than buffer vor 6 Jahren
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands vor 6 Jahren

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.