OVMS3-idf/examples/protocols
Ivan Grokhotkov 8cd1f99ace Merge branch 'refactor/common_rom_gpio_apis' into 'master'
esp_rom: extract common GPIO apis into esp_rom_gpio.h

See merge request espressif/esp-idf!9248
2020-07-07 17:28:39 +08:00
..
asio Add multi-target support for performance tests 2020-03-09 13:41:56 +01:00
cbor Add protocol example tests 2020-05-19 12:17:32 +02:00
coap_client coap: move mbedTLS config options from component to examples 2020-05-19 17:23:29 +05:30
coap_server coap: move mbedTLS config options from component to examples 2020-05-19 17:23:29 +05:30
esp_http_client ci: Temporarily remove the esp_http_client httpbin redirect tests 2020-06-24 03:26:39 +00:00
esp_local_ctrl Add protocol example tests 2020-05-19 12:17:32 +02: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 httpd_advanced_tests: Use the new low level APIs instead of calling an internal API 2020-06-11 01:56:47 +00:00
https_mbedtls Add ESP certificate bundle feature 2020-03-04 10:51:43 +08:00
https_request examples: make sure WiFi interface is disabled when connecting with Ethernet 2020-05-18 09:29:55 +02: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 feat(mbedtls): add dynamic buffer and local resource managment to decrease SSL heap cost 2020-05-14 11:45:09 +00:00
icmp_echo console_repl: change config structure to support different devices 2020-07-02 07:39:46 +00:00
mdns esp_rom: extract common GPIO apis into esp_rom_gpio.h 2020-07-07 11:40:19 +08:00
modbus/serial ci: temporarily disable RS485 related tests 2020-07-06 20:12:43 +00: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 pppos client: modem netif fix ignoring potential modem-start error 2020-06-18 16:20:50 +02:00
smtp_client examples/smtp: fix strict prototypes error in SMTP example 2020-02-06 16:40:13 +01:00
sntp Fix SNTP example test to match pattern 2020-06-04 13:46:47 +00:00
sockets esp-netif: Added API to get the underlying interface name 2020-05-18 09:26:24 +02:00
websocket Fix format string in websocket example 2020-04-02 22:48:58 +02: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.