OVMS3-idf/examples/protocols
Roland Dobai 01887f71e7 Update kconfiglib to upstream version and replace mconf-idf
Special thanks to @ulfalizer for the helpful suggestions regarding
kconfiglib.

"rsource" option is available for relative path includes
Closes https://github.com/espressif/esp-idf/issues/4064
2019-10-29 10:40:04 +01:00
..
asio ci: limit example test to ESP32s 2019-09-04 10:53:25 +10:00
cbor cbor: add tinycbor library and example 2019-08-22 17:44:29 +08:00
coap_client Fix libcoap building with various MbedTLS compile time options 2019-09-06 16:13:52 +05:30
coap_server Fix libcoap building with various MbedTLS compile time options 2019-09-06 16:13:52 +05:30
esp_http_client ci: limit example test to ESP32s 2019-09-04 10:53:25 +10:00
esp_local_ctrl Merge branch 'bugfix/strict_prototypes' into 'master' 2019-08-05 09:38:39 +08:00
http2_request Merge branch 'feature/esp32s2beta_merge' into 'master' 2019-10-29 13:02:01 +08:00
http_request Fix http_request example 2019-09-13 09:21:29 +00:00
http_server Merge branch 'master' into feature/esp32s2beta_merge 2019-10-17 18:22:08 +11:00
https_mbedtls Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 15:26:58 +10:00
https_request Merge branch 'feature/esp32s2beta_merge' into 'master' 2019-10-29 13:02:01 +08:00
https_server Merge branch 'master' into feature/esp32s2beta_merge 2019-09-16 16:18:48 +10:00
icmp_echo icmp: add example and unitest 2019-10-22 04:38:09 +00:00
mdns Merge branch 'master' into feature/esp32s2beta_merge 2019-10-25 15:13:52 +11:00
modbus_master Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 15:26:58 +10:00
modbus_slave Merge branch 'bugfix/strict_prototypes' into 'master' 2019-08-05 09:38:39 +08:00
mqtt Merge branch 'master' into feature/esp32s2beta_merge 2019-10-25 15:13:52 +11:00
openssl_client Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 13:44:24 +10:00
openssl_server Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 13:44:24 +10:00
pppos_client Merge branch 'master' into feature/esp32s2beta_merge 2019-10-22 13:51:49 +11:00
sntp Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 15:26:58 +10:00
sockets Update kconfiglib to upstream version and replace mconf-idf 2019-10-29 10:40:04 +01:00
websocket Merge branch 'master' into feature/esp32s2beta_merge 2019-10-17 18:22:08 +11:00
README.md build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10: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 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.