You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/esp_websocket_client/examples/target/README.md
+51-1Lines changed: 51 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,27 @@ This example can be executed on any ESP32 board, the only required interface is
15
15
* Configure the websocket endpoint URI under "Example Configuration", if "WEBSOCKET_URI_FROM_STDIN" is selected then the example application will connect to the URI it reads from stdin (used for testing)
16
16
* To test a WebSocket client example over TLS, please enable one of the following configurations: `CONFIG_WS_OVER_TLS_MUTUAL_AUTH` or `CONFIG_WS_OVER_TLS_SERVER_AUTH`. See the sections below for more details.
17
17
18
+
### Pre-configured SDK Configurations
19
+
20
+
This example includes several pre-configured `sdkconfig.ci.*` files for different testing scenarios:
21
+
22
+
***sdkconfig.ci** - Default configuration with WebSocket over Ethernet (IP101 PHY, ESP32, IPv6) and hardcoded URI.
23
+
***sdkconfig.ci.plain_tcp** - WebSocket over plain TCP (no TLS, URI from stdin) using Ethernet (IP101 PHY, ESP32, IPv6).
24
+
***sdkconfig.ci.mutual_auth** - WebSocket with mutual TLS authentication (client/server certificate verification, skips CN check) and URI from stdin.
25
+
***sdkconfig.ci.dynamic_buffer** - WebSocket with dynamic buffer allocation, Ethernet (IP101 PHY, ESP32, IPv6), and hardcoded URI.
* Mutual Authentication: When `CONFIG_WS_OVER_TLS_MUTUAL_AUTH=y` is enabled, it's essential to provide valid certificates for both the server and client.
@@ -73,7 +94,36 @@ idf.py -p PORT flash monitor
73
94
74
95
(To exit the serial monitor, type ``Ctrl-]``.)
75
96
76
-
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
97
+
See the [ESP-IDF Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.
98
+
99
+
## Testing with pytest
100
+
101
+
### Install Dependencies
102
+
103
+
Before running the pytest tests, you need to install the required Python packages:
104
+
105
+
```
106
+
pip install -r esp-protocols/ci/requirements.txt
107
+
```
108
+
109
+
### Run pytest
110
+
111
+
After installing the dependencies, you can run the pytest tests:
0 commit comments