hrushikesh.bhosale
7a50e3ab04
The WebSocket echo server tests connect immediately after seeing "Starting server on port:" in the device log, but URI handlers (/ws, /ws_partial, /auth) are registered asynchronously after the server starts, taking 40-660ms depending on config and CI load. This causes two failures: 1. WebSocket handshake returns 404 Not Found because the URI handler is not registered yet when the client connects. 2. WebSocket echo returns wrong data because the server is in a partially initialized state. Wait for "Returned from app_main()" before connecting, which guarantees all URI handlers are registered. Add connection retry with WebSocketBadStatusException handling to WsClient and to the partial frame test's raw websocket connection. Extract _wait_for_server_ready() helper to deduplicate the WiFi credential input and server readiness logic across all 3 tests.
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 or Thread Connection
About the example_connect() Function
Protocols examples use a simple helper function, example_connect(), to establish Wi-Fi, Ethernet, or/and Thread connection. This function is implemented in examples/common_components/protocol_examples_common/include/protocol_examples_common.h, 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, Thread or all connections, open the project configuration menu (idf.py menuconfig) and navigate to "Example Connection Configuration" menu. Select either "Wi-Fi" or "Ethernet" or "Thread" or all 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.
When connecting using Thread, enter the Thread network parameters in Component config-->OpenThread-->Thread Core Features-->Thread Operational Dataset. For instructions on starting or joining a Thread network, refer to the ot_cli example. If the example requires to access an IPv4 network, a Thread Border Router with NAT64 (Network Address Translation IPv6-IPv4) support is needed. You can follow this guide to set up the ESP Thread Border Router for testing.
Disabling IPv6
For examples using Wi-Fi or Ethernet connection, 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.
For examples using Thread connection, example_connect() waits until Thread device is attached to Thread network, and IPv6 addresses are obtained. Note that IPv6 cannot be disabled for Thread devices as Thread is IPv6-only network.