esp-idf/examples/protocols
Harshit Malpani fad1535a15
fix(ci): update HTTP client example tests runner assignment
HTTP client example tests now connect with locally hosted httpbin service
for more stable results across multiple runs
2023-07-24 11:38:11 +05:30
..
asio example_tests: Deletes usage esp32c3 ECO0 in CI (by default ECO3) 2021-09-24 13:55:07 +08:00
cbor
coap_client libcoap_430: Update code for use with libcoap 4.3.0 2021-08-31 12:05:30 +08:00
coap_server libcoap_430: Update code for use with libcoap 4.3.0 2021-08-31 12:05:30 +08:00
esp_http_client fix(ci): update HTTP client example tests runner assignment 2023-07-24 11:38:11 +05:30
esp_local_ctrl Added support for security1 in local control 2021-08-26 17:35:09 +08:00
http2_request esp_netif/lwip: Fix core-locking config (v4.4) 2023-03-21 10:31:20 +01:00
http_request [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
http_server example: fix got ip error in protocol tests 2023-02-14 11:03:37 +08:00
https_mbedtls [examples]: removed hyphens 2021-10-09 13:58:24 +08:00
https_request examples: add dependency on cert bundle configuration 2022-06-12 09:30:31 +05:30
https_server test: fix test_examples_protocol_https_server_simple 2023-02-15 15:42:58 +08:00
https_x509_bundle tests: update Root certificate for the test endpoints 2023-05-17 15:28:46 +05:30
icmp_echo CI: optimize example protocol test cases 2023-02-10 15:30:44 +08:00
mdns mDNS: Fix example test in CI using multiple retries 2023-01-01 19:58:19 +00:00
modbus freemodbus: remove component files from esp-idf (backport v4.4) 2022-12-22 17:05:55 +08:00
mqtt configure_ds.py: Fix the error for prod mode. They script now only verifies the purpose in the prod mode. 2022-02-21 01:33:00 +05:30
pppos_client Examples/PPPoS: Add troubleshooting to correctly power modem 2021-12-02 09:09:23 +01:00
slip/slip_udp
smtp_client smtp_client: Fixed garbage characters being printed 2022-04-18 10:33:02 +05:30
sntp esp_netif/lwip: Fix core-locking config (v4.4) 2023-03-21 10:31:20 +01:00
sockets CI: optimize example protocol test cases 2023-02-10 15:30:44 +08:00
static_ip esp_wifi: Always connect Station in PMF mode if possible 2022-02-28 17:55:42 +05:30
websocket websocket: Updated Kconfig to use 'echo.websocket.events' echo server 2022-04-19 07:36:53 +00:00
README.md

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.