esp-idf/examples/protocols
Aditya Patwardhan c66c18596c Merge branch 'fix/https_request_example_test' into 'master'
https_request_example: Update the example test to use local python server

See merge request espressif/esp-idf!15931
2021-12-07 11:14:34 +00:00
..
asio asio: Use internal ssl context and engine impl 2021-12-03 09:32:42 +01:00
cbor other: Move cbor, jsmn and libsodium to idf-component-manager 2021-11-30 21:44:48 +01:00
coap_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
coap_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_http_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
esp_local_ctrl Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
http2_request Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
http_request Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
http_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
https_mbedtls Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
https_request https_request_example: 2021-12-05 02:54:52 +08:00
https_server Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
https_x509_bundle Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
icmp_echo Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mdns Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
modbus Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
mqtt Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
slip/slip_udp Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
smtp_client Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
sntp Examples/lwip: sntp example - Make SNTP server configurable 2021-11-25 08:50:29 +01:00
sockets Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
static_ip Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
websocket Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
README.md examples: common connect component to use both interfaces at once 2020-05-18 09:26:24 +02: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/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.