OVMS3-idf/examples/protocols
2019-06-20 15:37:40 +08:00
..
asio Rename Kconfig options (components/esp32) 2019-05-21 09:09:01 +02:00
coap_client examples/protocols/coap: use common network component 2019-04-15 03:32:05 +00:00
coap_server examples/protocols/coap: use common network component 2019-04-15 03:32:05 +00:00
esp_http_client examples/protocols/esp_http_client: use common network component 2019-04-15 03:32:05 +00:00
http2_request examples/protocols/http(s,2)_request: use common network component 2019-04-15 03:32:05 +00:00
http_request examples/protocols/http(s,2)_request: use common network component 2019-04-15 03:32:05 +00:00
http_server Example restful_server : Minor fix in copying file system base path 2019-06-12 05:43:17 +00:00
https_mbedtls mbedtls: add config option for setting debug level 2019-06-06 18:28:19 +05:30
https_request examples/protocols/http(s,2)_request: use common network component 2019-04-15 03:32:05 +00:00
https_server examples/protocols/http(s)_server: use common network component 2019-04-15 03:32:05 +00:00
mdns Rename Kconfig options (examples) 2019-05-21 09:32:55 +02:00
modbus_master Rename Kconfig options (components/freemodbus) 2019-05-21 09:09:01 +02:00
modbus_slave Rename Kconfig options (components/freemodbus) 2019-05-21 09:09:01 +02:00
mqtt mqtt: added support for esp event loop, updating examples to register and use event loop handler 2019-06-04 07:41:27 +02:00
openssl_client examples/protocols/openssl: use common network component 2019-04-15 03:32:05 +00:00
openssl_server examples/protocols/openssl: use common network component 2019-04-15 03:32:05 +00:00
pppos_client Rename Kconfig options (examples) 2019-05-21 09:32:55 +02:00
sntp sntp/lwip: Add some modes for time synchronization 2019-04-15 18:11:47 +08:00
sockets udp_multicast_example: better handling wrong addresses 2019-04-17 06:52:23 +00:00
websocket esp_websocket_client: Add websocket client component 2019-06-20 15:37:40 +08:00
README.md examples: add component for protocol examples network functionality 2019-04-15 03:32:05 +00: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/ethernet/ examples.

Configuring the Example

To configure the example to use Wi-Fi or Ethernet connection, run make menuconfig (or idf.py menuconfig if using CMake build system) 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.