alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
445b1a6717
esp-idf/examples/protocols
History
Fu Hanxi 0146f258d7 style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
..
asio style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
cbor style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08: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 style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
esp_local_ctrl style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
http2_request http2_request: Enable insecure TLS by default 2021-01-18 16:05:46 +05:30
http_request Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
http_server style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
https_mbedtls Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_request style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
https_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_x509_bundle style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
icmp_echo style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
mdns style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
modbus style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
mqtt style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08: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 style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
slip/slip_udp bugfix for ipv6_address_value_issue 2020-11-13 08:55:32 +00:00
smtp_client Fixed content type of attachment 2020-11-10 11:57:20 +05:30
sntp style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
sockets style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
websocket style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08: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.