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
d311144a00
esp-idf/examples/protocols
History
Axel Lin 85e9930071 esp_modem: Fix misuse event_queue_size as pattern_queue_size 
Also remove event_queue_size from esp_modem_dte_t because
event_queue_size is only used in esp_modem_dte_init.

Fixes: 817c0e3019 ("esp_modem: UART runtime configuration of esp-modem")
Signed-off-by: Axel Lin <axel.lin@gmail.com>
2020-04-25 08:08:01 +08:00
..
asio Add multi-target support for performance tests 2020-03-09 13:41:56 +01:00
cbor cbor: add tinycbor library and example 2019-08-22 17:44:29 +08:00
coap_client esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 2019-12-17 09:07:49 +01:00
coap_server esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 2019-12-17 09:07:49 +01:00
esp_http_client examples: Add example to demonstrate use of low level APIs for GET and POST requests 2020-03-23 10:45:39 +05:30
esp_local_ctrl test, examples: use new component registration function 2020-03-23 10:58:48 +08:00
http2_request Fixed broken http2_request example. 2020-03-23 05:16:40 +00:00
http_request esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 2019-12-17 09:07:49 +01:00
http_server http-server-example: correction of regex waiting to acquire IP address 2020-04-05 20:07:27 +02:00
https_mbedtls Add ESP certificate bundle feature 2020-03-04 10:51:43 +08:00
https_request Add multi-target support for performance tests 2020-03-09 13:41:56 +01:00
https_server esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 2019-12-17 09:07:49 +01:00
https_x509_bundle test, examples: use new component registration function 2020-03-23 10:58:48 +08:00
icmp_echo console: simplify examples 2020-02-07 20:15:06 +08:00
mdns Add multi-target support for performance tests 2020-03-09 13:41:56 +01:00
modbus/serial freemodbus: fix long buffer failure 2020-03-30 22:05:48 +08:00
mqtt test, examples: use new component registration function 2020-03-23 10:58:48 +08:00
openssl_client Added simple SMTP email client. 2020-02-04 18:13:28 +05:30
openssl_server esp_netif, examples: esp_netif_init() moved into ESP_ERROR_CHECK() 2019-12-17 09:07:49 +01:00
pppos_client esp_modem: Fix misuse event_queue_size as pattern_queue_size 2020-04-25 08:08:01 +08:00
smtp_client examples/smtp: fix strict prototypes error in SMTP example 2020-02-06 16:40:13 +01:00
sntp build_app: make multi target support readable 2020-04-09 16:40:57 +08:00
sockets example: Remove duplicate commands and invalid serial port information 2020-04-08 13:17:48 +02:00
websocket Fix format string in websocket example 2020-04-02 22:48:58 +02:00
README.md build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10: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 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 or Ethernet connection, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" 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.