Начало Каталог Помощ
Вход
RT-Thread-packages
/
esp-idf
огледало от https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Разклонения 0
Файлове Задачи 0 Уики
ИН на ревизия: 4fa13a8575
Клонове Маркери
esp-idf
/
examples
/
protocols
Angus Gratton 3f8a89504f Merge branch 'feature/ws_local_server_test_v4.0' into 'release/v4.0' преди 6 години
..
asio 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
coap_client 70af759dd2 examples: change default build instructions in docs to CMake преди 6 години
coap_server 70af759dd2 examples: change default build instructions in docs to CMake преди 6 години
esp_http_client 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
esp_local_ctrl 509ac2cfc1 examples: using xEventGroup bits properly преди 6 години
http2_request 6771eead80 examples: use new component registration api преди 6 години
http_request 6771eead80 examples: use new component registration api преди 6 години
http_server 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
https_mbedtls 6771eead80 examples: use new component registration api преди 6 години
https_request 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
https_server 47bbb107a8 build system: Use CMake-based build system as default when describing commands преди 6 години
mdns 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
modbus_master 70af759dd2 examples: change default build instructions in docs to CMake преди 6 години
modbus_slave 70af759dd2 examples: change default build instructions in docs to CMake преди 6 години
mqtt 6e05a79536 test: update example and unit tests with new import roles: преди 6 години
openssl_client 47bbb107a8 build system: Use CMake-based build system as default when describing commands преди 6 години
openssl_server 47bbb107a8 build system: Use CMake-based build system as default when describing commands преди 6 години
pppos_client 4283b59dde MQTT: update default broker URL for examples преди 6 години
sntp 47bbb107a8 build system: Use CMake-based build system as default when describing commands преди 6 години
sockets 70af759dd2 examples: change default build instructions in docs to CMake преди 6 години
websocket 5cb04f3e13 websocket_client: added example_test with a local websocket server преди 6 години
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands преди 6 години

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