eaw/esp-idf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Add user-friendly guide about how to use ws_server_example_test.py

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/8060
This commit is contained in:
Yuan Jian Min
2022-01-02 11:27:05 +00:00
committed by yuanjm
parent 813948d137
commit 2a89b3c15a
3 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
examples/protocols/http_server/ws_echo_server/README.md
View File

@@ -6,7 +6,8 @@ This example demonstrates the HTTPD server using the WebSocket feature.
## How to Use Example
The example starts a websocket server on a local network. You need a websocket client to interact with the server (an example test
ws_server_example_test.py could be used as the simple websocket client).
ws_server_example_test.py could be used as the simple websocket client). If you run ws_server_example_test.py and get
`ModuleNotFoundError: No module named 'websocket'`, then please install `websocket` by running `python -m pip install websocket-client`.
The server registers websocket handler which echoes back the received WebSocket frame. It also demonstrates
use of asynchronous send, which is triggered on reception of a certain message.