esp-idf/examples/protocols
Axel Lin d6248eaf9b Examples: esp_modem_dce_service: Make esp_modem_dce_handle_* functions static
These functions are unlikely to be reused, make them static.
Take esp_modem_dce_handle_cbc as an example, it's internal implementation
of esp_modem_dce_get_battery_status, expose esp_modem_dce_get_battery_status
function is enough.

Signed-off-by: Axel Lin <axel.lin@gmail.com>

Merges https://github.com/espressif/esp-idf/pull/7266
2021-07-26 11:48:15 +02:00
..
asio CI: fix connection failures in asio example tests 2021-06-07 04:04:14 +00:00
cbor
coap_client Update the coap client example URL and README 2021-07-21 12:58:24 +08:00
coap_server
esp_http_client examples/esp_http_client: `output_buffer` isn't necessarily NUL-terminated 2021-05-10 05:45:59 +00:00
esp_local_ctrl
http2_request Disable the example test for http2 request example. 2021-07-13 13:21:08 +08:00
http_request Add longer dut.expect timeout DNS -> 30s 2021-05-31 17:40:54 +02:00
http_server
https_mbedtls
https_request Add sdkconfig which disables all menuconfig options in mbedtls. 2021-06-21 17:53:22 +05:30
https_server
https_x509_bundle
icmp_echo usb_serial_jtag: Add blocking driver to support vfs. 2021-07-05 11:22:38 +08:00
mdns CI: mdns example test: start responder after valid IP 2021-07-01 15:45:17 +02:00
modbus
mqtt
openssl_client examples: Add esp-ssl example tests `server/client` 2021-04-21 16:18:03 +04:00
openssl_server examples: Add esp-ssl example tests `server/client` 2021-04-21 16:18:03 +04:00
pppos_client Examples: esp_modem_dce_service: Make esp_modem_dce_handle_* functions static 2021-07-26 11:48:15 +02:00
slip/slip_udp
smtp_client
sntp
sockets examples: Move non-block socket examples to a single app 2021-06-25 20:46:49 +08:00
static_ip example: Add DNS configure and test for static ip example 2021-07-21 14:46:59 +08:00
websocket
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.