esp-idf/examples/protocols
David Cermak 55d41c3377 esp_modem: Fixed race condition on exiting PPP mode
esp_modem_stop_ppp() stops both ppp netif and switches the modem back to
command mode. IF these two actions are not synchronised, we might
experience issues of
* active PPP session trying to send/receive uart-data
* command mode already active before modem switched to it
both resulting in crashes.
Fixed by introducing the transition mode and running these actions in sequence
* set esp-modem to transition mode
* enter command mode, wait for the reply or re-sync
* close the PPP netif
* wait until the netif closes
Other fixes include ignoring certain events if modem component not ready
or not in appropriate mode:
* ignoring all UART events comming from DTE with no DCE attached
* ignore pattern detection in PPP mode

Closes https://github.com/espressif/esp-idf/issues/6013
Closes https://github.com/espressif/esp-idf/issues/5737
Closes https://github.com/espressif/esp-idf/issues/6024
Closes https://github.com/espressif/esp-idf/issues/6058
Closes https://github.com/espressif/esp-idf/issues/5563
Closes https://github.com/espressif/esp-idf/issues/5695
Closes https://github.com/espressif/esp-idf/issues/5633
Closes https://github.com/espressif/esp-idf/issues/4482
Related https://github.com/espressif/esp-idf/pull/4849
Related https://github.com/espressif/esp-idf/pull/4653
2020-12-21 16:38:20 +01:00
..
asio test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08: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 esp_http_client example: Update example to demonstrate partial HTTP downloads 2020-12-03 09:39:16 +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 test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
https_mbedtls Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_request test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
https_server Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
https_x509_bundle test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
icmp_echo console: support create REPL over USB CDC 2020-11-13 10:51:40 +08:00
mdns test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
modbus Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
mqtt Merge branch 'fix/https_server_mem_leak_for_error_ret' into 'master' 2020-11-26 00:11:58 +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 esp_modem: Fixed race condition on exiting PPP mode 2020-12-21 16:38:20 +01: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 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sockets test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
websocket test: remove fake binary size check in example test: 2020-11-24 17:53:33 +08:00
README.md examples: common connect component to use both interfaces at once 2020-05-18 09:26:24 +02:00

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.