esp-idf/examples/protocols
Marius Vikhammer 425c9e5b0f Merge branch 'feature/target_kconfig_movement_3' into 'master'
kconfig: move remaining kconfig options out of target component

Closes IDF-3579

See merge request espressif/esp-idf!18046
2022-05-24 08:45:01 +08:00
..
asio [EXAMPLES/ASIO] Renames Kconfig parameter and clarify 2022-04-13 11:22:34 -03:00
cbor Migrate cbor example to pytest framework 2022-05-13 04:41:00 +00:00
coap_client Fixed the commented out coap_new_optlist() example in the coap_client example. 2022-04-28 18:49:55 +09:00
coap_server managed components: fix version references to allow implicit updates according to semver 2022-03-11 13:49:26 +07:00
esp_http_client esp_http_client example: Add cert for redirect to HTTPS example 2022-04-22 17:39:12 +05:30
esp_local_ctrl esp_local_ctrl example pytest migration 2022-05-17 15:23:22 +05:30
http2_request kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
http_request Add sdkconfig.h to protocol/https* examples 2022-05-11 07:09:34 +00:00
http_server Updated coding style and added error logs 2022-05-11 08:58:01 +00:00
https_mbedtls kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
https_request Merge branch 'feature/target_kconfig_movement_3' into 'master' 2022-05-24 08:45:01 +08:00
https_server https_server: add mbedtls dynamic buffer function test 2022-05-20 11:21:48 +00:00
https_x509_bundle protocols: Updated examples to use correct API 2022-04-20 12:18:26 +05:30
icmp_echo Update echo_example_main.c 2022-05-16 11:30:55 -05:00
l2tap examples: added ESP-NETIF L2 TAP example 2022-04-12 12:33:57 +00:00
mdns Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
modbus Examples: common source for GPIO range in Kconfigs defined 2022-05-12 09:33:40 +02:00
mqtt esp_netif: Remove tcpip_adapter compatibility layer 2022-03-10 08:19:43 +01:00
slip/slip_udp G0: target component (components/esp32*) doesn't depend on driver anymore 2022-03-02 04:21:00 +00:00
smtp_client smtp_client: Fixed garbage characters being printed 2022-04-14 13:35:02 +05:30
sntp examples/sntp: Document that SNTP-over-DHCP resets other NTP servers 2022-03-22 15:01:02 +00:00
sockets udp example:Optimization udp example with recv_msg 2022-04-28 07:55:28 +00:00
static_ip esp_wifi: Always connect Station in PMF mode if possible 2022-02-21 11:31:56 +05:30
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.