OVMS3-idf/examples/protocols
2020-07-07 18:07:57 +08:00
..
asio test: update example and unit tests with new import roles: 2019-12-11 15:57:49 +11:00
coap_client examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
coap_server examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
esp_http_client test: update example and unit tests with new import roles: 2019-12-11 15:57:49 +11:00
esp_local_ctrl Docs: Encourage to used Python 3 2020-02-26 09:01:42 +01:00
http2_request examples: use new component registration api 2019-06-21 19:53:29 +08:00
http_request examples: use new component registration api 2019-06-21 19:53:29 +08:00
http_server tools: fix python lint 2020-06-24 13:22:21 +08:00
https_mbedtls examples: use new component registration api 2019-06-21 19:53:29 +08:00
https_request test: update example and unit tests with new import roles: 2019-12-11 15:57:49 +11:00
https_server build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
mdns test: update example and unit tests with new import roles: 2019-12-11 15:57:49 +11:00
modbus_master examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
modbus_slave examples: change default build instructions in docs to CMake 2019-08-06 17:25:25 +05:30
mqtt update mqtt weekend test to use mbedtls asymetric buffer 2020-02-25 18:32:27 +07:00
openssl_client build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
openssl_server build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
pppos_client Fix broken README links 2020-07-07 18:07:57 +08:00
sntp build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00
sockets socket-examples: IPv6 related update for examples to set correct scoped id 2020-05-22 06:19:49 +00:00
websocket tcp_transport/ws_client: websockets now correctly handle messages longer than buffer 2020-02-28 10:53:08 +08: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.