esp-idf/examples/protocols
Ivan Grokhotkov ba874ccb04 Merge branch 'feature/freemodbus_add_tcp_master_slave' into 'master'
freemodbus:  add tcp master and slave support

Closes IDFGH-1147 and IDF-452

See merge request espressif/esp-idf!7506
2020-07-22 00:34:06 +08:00
..
asio asio: make the example code conform to Espressif C++ standards 2020-07-14 10:42:17 +00:00
cbor
coap_client
coap_server
esp_http_client ci: Temporarily remove the esp_http_client httpbin redirect tests 2020-06-24 03:26:39 +00:00
esp_local_ctrl
http2_request
http_request
http_server Merge branch 'bugfix/ws_server_async_send_fin' into 'master' 2020-07-15 05:31:02 +08:00
https_mbedtls
https_request
https_server httpd_resp_send: use `HTTPD_RESP_USE_STRLEN` when possible 2020-07-13 05:34:56 +00:00
https_x509_bundle
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 examples: freemodbus add tcp support for common master/slave iface 2020-07-22 00:34:04 +08:00
mqtt
openssl_client
openssl_server
pppos_client esp-netif: Added esp_netif slip support, slip_modem component and example 2020-07-15 15:46:46 +02:00
slip/slip_udp esp-netif: removing SLIP related events as the slip-modem set state synchronously 2020-07-15 15:46:46 +02:00
smtp_client
sntp
sockets docs: fix broken links in example READMEs 2020-07-08 10:39:33 +08:00
websocket
README.md

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 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.