Marius Vikhammer d3ca964e5f fix(ci): fixed misnamed kconfig option in https server ci config 2 tahun lalu
..
esp_http_client 77bb19c49e ci(build): fixed/ignored warnings from unknown symbols in sdkconfig.defaults 2 tahun lalu
esp_local_ctrl 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
http_request 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
http_server 77bb19c49e ci(build): fixed/ignored warnings from unknown symbols in sdkconfig.defaults 2 tahun lalu
https_mbedtls 2da0b61374 fix: Update https_mbedtls example to fix TLS v1.2 connection 2 tahun lalu
https_request 95703297a6 Merge branch 'ci/psram_config_fix' into 'master' 2 tahun lalu
https_server d3ca964e5f fix(ci): fixed misnamed kconfig option in https server ci config 2 tahun lalu
https_x509_bundle 77bb19c49e ci(build): fixed/ignored warnings from unknown symbols in sdkconfig.defaults 2 tahun lalu
icmp_echo 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
l2tap 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
linux_stubs b2af4d9689 lwip/linux: Add lwip support for networking component under linux 3 tahun lalu
modbus c5b2291eea modbus: fix -wno-format issues in the examples 2 tahun lalu
mqtt 327629c527 feat(example): Use PPP config in one MQTT example 2 tahun lalu
mqtt5 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
smtp_client 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
sntp 6d87100a70 feat(examples): add local components via idf_component.yml 2 tahun lalu
sockets fa1a3ce0b5 Merge branch 'refactor/components_linux_compatible' into 'master' 2 tahun lalu
static_ip c07d237ffe examples: enable build esp32c6 for wifi and network examples 3 tahun lalu
.build-test-rules.yml 2f46d9686d feat(mqtt/example): Adds custom outbox example 2 tahun lalu
README.md bf0e4943be common_components: add wifi connect console commands 3 tahun lalu

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.