Accueil Explorer Aide
Connexion
RT-Thread-packages
/
esp-idf
miroir de https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: f73cd1d4f1
Branches Tags
esp-idf
/
examples
/
protocols
Marius Vikhammer 4ff6d873bb Fix broken README links il y a 5 ans
..
asio 6e05a79536 test: update example and unit tests with new import roles: il y a 6 ans
coap_client 70af759dd2 examples: change default build instructions in docs to CMake il y a 6 ans
coap_server 70af759dd2 examples: change default build instructions in docs to CMake il y a 6 ans
esp_http_client 6e05a79536 test: update example and unit tests with new import roles: il y a 6 ans
esp_local_ctrl 2a4173e9a6 Docs: Encourage to used Python 3 il y a 6 ans
http2_request 6771eead80 examples: use new component registration api il y a 6 ans
http_request 6771eead80 examples: use new component registration api il y a 6 ans
http_server b53c59b7a4 tools: fix python lint il y a 5 ans
https_mbedtls 6771eead80 examples: use new component registration api il y a 6 ans
https_request 6e05a79536 test: update example and unit tests with new import roles: il y a 6 ans
https_server 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans
mdns 6e05a79536 test: update example and unit tests with new import roles: il y a 6 ans
modbus_master 70af759dd2 examples: change default build instructions in docs to CMake il y a 6 ans
modbus_slave 70af759dd2 examples: change default build instructions in docs to CMake il y a 6 ans
mqtt 80fd327308 update mqtt weekend test to use mbedtls asymetric buffer il y a 6 ans
openssl_client 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans
openssl_server 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans
pppos_client 4ff6d873bb Fix broken README links il y a 5 ans
sntp 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans
sockets acf1478a51 socket-examples: IPv6 related update for examples to set correct scoped id il y a 5 ans
websocket f542c979e9 tcp_transport/ws_client: websockets now correctly handle messages longer than buffer il y a 6 ans
README.md 47bbb107a8 build system: Use CMake-based build system as default when describing commands il y a 6 ans

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.