alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
e76c52d4df
esp-idf/examples/protocols
History
David Cermak 7294438329 sntp/test: Fixed flaky example test 
From SNTP update in a71fa821, the example test uses notification event
(before it simply polled the state in 2 seconds interval). With this
change it is possible that the time gets synchronized before retrying,
i.e. printing "Waiting for system time to be set... (2/15)". (it was
theoretically possible also before this change, but practically never
happened)
2023-02-01 08:01:54 +01:00
..
coap_client examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
coap_server examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
esp_http_client examples/protocols: Added URI encoding/decoding feature 2023-01-25 17:47:14 +05:30
esp_local_ctrl Merge branch 'fix/esp_local_ctrl_header_incl' into 'master' 2023-01-13 23:47:55 +08:00
http2_request esp_netif/lwip: Fix core-locking config 2023-01-17 16:15:58 +01:00
http_request examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
http_server examples/protocols: Added URI encoding/decoding feature 2023-01-25 17:47:14 +05:30
https_mbedtls examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
https_request esp_netif/lwip: Fix core-locking config 2023-01-17 16:15:58 +01:00
https_server examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
https_x509_bundle examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
icmp_echo examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
l2tap examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
linux_stubs/esp_stubs Update esp_http_client example to build for linux target 2023-01-04 11:20:43 +05:30
modbus examples: modbus add esp32c2 esp32c6 targets 2023-01-28 00:45:46 +08:00
mqtt ci: Enable build stage for mqtt/ssl_ds example for esp32c6 2023-01-19 10:00:00 +05:30
mqtt5 examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
smtp_client examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
sntp sntp/test: Fixed flaky example test 2023-02-01 08:01:54 +01:00
sockets examples: Update socket udp_client to support lwip on linux 2023-01-31 08:43:50 +01:00
static_ip examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
.build-test-rules.yml examples: modbus add esp32c2 esp32c6 targets 2023-01-28 00:45:46 +08:00
README.md common_components: add wifi connect console commands 2022-07-15 01:16:27 +08:00

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/include/protocol_examples_common.h, 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.