esp-idf/examples/protocols
2022-12-23 12:14:25 +05:30
..
cbor cbor: Update cbor component version in idf_component.yml file in example 2022-11-09 18:03:26 +05:30
coap_client example: Add coap_client example_test 2022-08-16 09:52:00 +05:30
coap_server coap: Update examples to use latest features of libcoap component 2022-07-28 13:11:52 +00:00
esp_http_client ci: Make consistence between pytest_*.py and .build-test-rules.yml for esp32c6 (i.e. to pass check_test_scripts_build_test_rules.py) 2022-11-28 11:58:30 +08:00
esp_local_ctrl esp_local_ctrl: Add support for insecure HTTP server transport 2022-12-23 12:14:25 +05:30
http2_request docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
http_request docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
http_server esp_http_server: fix wrong context pointer in httpd_req_cleanup function 2022-12-16 14:40:37 +05:30
https_mbedtls protocols/security: Remove -Wno-format compile option for examples 2022-12-07 13:02:00 +05:30
https_request protocols/security: Remove -Wno-format compile option for examples 2022-12-07 13:02:00 +05:30
https_server esp_netif/lwip: Fix deps cycles to "lwip -> esp_netif -> phy-drivers" 2022-07-20 14:59:07 +02:00
https_x509_bundle ci: fix https_x509 example 2022-11-02 14:57:14 +05:30
icmp_echo doc: redirect console page 2022-11-02 14:21:57 +08:00
l2tap docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
modbus build system: re-add -Wno-format as private flag for some example components 2022-08-03 16:42:47 +04:00
mqtt Examples: migration mqtt examples to pytest 2022-12-20 17:48:48 +04:00
mqtt5 CI: fix pattern in test case test_examples_protocol_mqtt5 2022-12-21 10:50:11 +08:00
smtp_client docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
sntp esp-netif: Support non-lwip mode, add test 2022-12-14 14:12:50 +00:00
sockets example: add socket scripts again 2022-12-16 19:03:25 +08:00
static_ip docs: changes docs supported targets tables 2022-07-14 08:26:32 +08:00
.build-test-rules.yml ci: Enable esp32c6 example, test_apps, and unit tests CI build stage 2022-11-01 11:23:21 +08:00
README.md common_components: add wifi connect console commands 2022-07-15 01:16:27 +08:00

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.