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
7cf7bec582
esp-idf/examples/protocols
History
Angus Gratton 9d72bdda58 asio coap: If LWIP IPV6 is disabled, automatically don't build asio & coap 
- Removes need to manually exclude these components as shown at
  https://github.com/espressif/esp-idf/issues/3781#issuecomment-825742378

- Hide the config for these components if IPV6 is disabled

- The components are still included in the build, but with no source
  files

Backport of e305f29382

Closes https://github.com/espressif/esp-idf/issues/7816
2021-11-23 22:39:58 +08:00
..
asio CI: fix connection failures in asio example tests 2021-06-08 17:00:55 +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 Update example test for esp_http_client 2021-10-07 17:47:12 +05:30
esp_local_ctrl Added support for security1 in local control 2021-09-21 09:21:18 +05:30
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 CI: enable example builds for C3 2021-02-09 12:04:02 +08:00
https_mbedtls Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_request Updated the root certificate of https examples 2021-10-07 17:46:02 +05:30
https_server CI: enable example builds for C3 2021-02-09 12:04:02 +08: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 freemodbus: check/fix reinitialization issues (tcp master and slave examples) 2021-10-15 16:50:33 +08:00
mqtt bugfix/mqtt examples: Updates the CA certificates used. 2021-05-13 06:51:43 +02: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 docs: fixed dead readme links 2021-07-21 17:48:11 +08:00
slip/slip_udp bugfix for ipv6_address_value_issue 2020-11-13 08:55:32 +00:00
smtp_client Updated the root certificate of https examples 2021-10-07 17:46:02 +05:30
sntp style: format python files with isort and double-quote-string-fixer 2021-01-26 10:49:01 +08:00
sockets asio coap: If LWIP IPV6 is disabled, automatically don't build asio & coap 2021-11-23 22:39:58 +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.