esp-idf/examples/protocols
Ivan Grokhotkov 3a01196eb0 Merge branch 'bugfix/smtp_client_attachment_newline' into 'master'
Add newline separator to fix wrong attachment sent

Closes IDFGH-4240

See merge request espressif/esp-idf!11177
2020-11-18 07:42:38 +08:00
..
asio Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
cbor Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
coap_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
coap_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
esp_http_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
esp_local_ctrl Merge branch 'fix/esp_local_ctrl_update_expired_cert' into 'master' 2020-11-11 19:40:02 +08:00
http2_request Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
http_request Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
http_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_mbedtls Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_request Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_x509_bundle Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
icmp_echo console: support create REPL over USB CDC 2020-11-13 10:51:40 +08:00
mdns Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
modbus Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
mqtt Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
openssl_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
openssl_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
pppos_client Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
slip/slip_udp Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
smtp_client Fixed content type of attachment 2020-11-10 11:57:20 +05:30
sntp Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sockets Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
websocket Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
README.md examples: common connect component to use both interfaces at once 2020-05-18 09:26:24 +02:00

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.