WebSocket AT 示例

本文档介绍了在 ESP32-C3 设备上运行 WebSocket AT 命令集命令的详细示例。

基于 TCP 的 WebSocket 连接
基于 TLS 的 WebSocket 连接（相互鉴权）

重要

默认的 AT 固件不支持 WebSocket 功能。如果您需要 ESP32-C3 支持 WebSocket 功能，请参考介绍。

基于 TCP 的 WebSocket 连接 

设置 Wi-Fi 模式为 station。

命令：
```
AT+CWMODE=1
```
响应：
```
OK
```
连接到路由器。

命令：
```
AT+CWJAP="espressif","1234567890"
```
响应：
```
WIFI CONNECTED
WIFI GOT IP

OK
```
说明：
- 您输入的 SSID 和密码可能跟上述命令中的不同。请使用您的路由器的 SSID 和密码。
PC 与 ESP32-C3 设备连接同一个路由。

在 PC 上使用 python 创建一个基于 TCP 的 WebSocket 服务器。示例代码如下：

#!/usr/bin/env python

import asyncio
from websockets.server import serve

host = "192.168.200.249"
port = 8765

async def echo(websocket):
    async for message in websocket:
        await websocket.send(message)

async def main():
    async with serve(echo, host, port):
        print(f"Server started at ws://{host}:{port}")
        await asyncio.get_running_loop().create_future()  # run forever

asyncio.run(main())

请修改上述代码中的 host 为 PC 的 IP 地址并保存为 ws-server.py 文件，同时运行该程序。

python ws-server.py

说明：

如果您的 PC 上没有安装 websockets 库，请使用 pip install websockets 安装。
默认设置的 WebSocket 服务器端口为 8765，您也可以设置为其它端口。

ESP32-C3 设备作为客户端连接到 WebSocket 服务器。

命令：
```
AT+WSOPEN=0,"ws://192.168.200.249:8765"
```
响应：
```
+WS_CONNECTED:0

OK
```
发送 4 字节数据。

命令：
```
AT+WSSEND=0,4
```
响应：
```
OK

>
```
输入 4 字节数据，例如输入数据是 test，之后 AT 将会输出以下信息。
```
SEND OK
```
说明：
- 若输入的字节数目超过 AT+WSSEND 命令设定的长度 (n)，则系统会响应 busy p...，并发送数据的前 n 个字节，发送完成后响应 SEND OK。
接收 4 字节数据。

由于上面的 WebSocket 服务器是一个回显服务器，因此在数据发送后，服务器也会原样返回该数据，即 AT 会输出：
```
+WS_DATA:0,4,test
```

基于 TLS 的 WebSocket 连接（相互鉴权）

设置 Wi-Fi 模式为 station。

命令：
```
AT+CWMODE=1
```
响应：
```
OK
```
连接到路由器。

命令：
```
AT+CWJAP="espressif","1234567890"
```
响应：
```
WIFI CONNECTED
WIFI GOT IP

OK
```
说明：
- 您输入的 SSID 和密码可能跟上述命令中的不同。请使用您的路由器的 SSID 和密码。
设置 SNTP 服务器。

命令：
```
AT+CIPSNTPCFG=1,8,"cn.ntp.org.cn","ntp.sjtu.edu.cn"
```
响应：
```
OK
```
说明：
- 您可以根据自己国家的时区设置 SNTP 服务器。
查询 SNTP 时间。

命令：
```
AT+CIPSNTPTIME?
```
响应：
```
+CIPSNTPTIME:Wed Nov 13 17:00:15 2024
OK
```
说明：
- 您可以查询 SNTP 时间与实时时间是否相符来判断您设置的 SNTP 服务器是否生效。
PC 与 ESP32-C3 设备连接同一个路由。

获取 WebSocket 服务器端的 CA、证书、私钥。

您可以使用 openssl 工具生成 CA、证书、和私钥。如果遇到困难，请使用以下配置进行测试：

server_ca.crt

server.crt

server.key

在 PC 上使用 python 创建一个基于 TLS 的 WebSocket 服务器。示例代码如下：

#!/usr/bin/env python

import asyncio
import ssl
import websockets

host = '192.168.200.249'
port = 8766
server_ca = '/your_path/server_ca.crt'
server_cert = '/your_path/server.crt'
server_key = '/your_path/server.key'

async def echo(websocket, path):
    async for message in websocket:
        await websocket.send(message)

ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
ssl_context.load_cert_chain(certfile=server_cert, keyfile=server_key)
ssl_context.verify_mode = ssl.CERT_REQUIRED
ssl_context.load_verify_locations(server_ca)

start_server = websockets.serve(echo, host, port, ssl=ssl_context)

asyncio.get_event_loop().run_until_complete(start_server)
print(f"Server started at wss://{host}:{port}")

asyncio.get_event_loop().run_forever()

请修改上述代码中的 host 为 PC 的 IP 地址， server_ca、 server_cert、 server_key 为服务器端的 CA、证书、和私钥路径，并保存为 wss-server.py 文件，同时运行该程序。

python wss-server.py

说明：

如果您的 PC 上没有安装 websockets 库，请使用 pip install websockets 安装。
设置的 WebSocket 服务器端口为 8766，您也可以设置为其它端口。

配置 WebSocket 连接为相互鉴权。

命令：
```
AT+WSCFG=0,30,60,4096,3,0,0
```
响应：
```
OK
```
说明：
- 如果您想使用自己的客户端证书或者使用多套证书，请参考如何更新 PKI 配置。
ESP32-C3 设备作为客户端连接到 WebSocket 服务器。

命令：
```
AT+WSOPEN=0,"wss://192.168.200.249:8766"
```
响应：
```
+WS_CONNECTED:0

OK
```
发送 4 字节数据。

命令：
```
AT+WSSEND=0,4
```
响应：
```
OK

>
```
输入 4 字节数据，例如输入数据是 test，之后 AT 将会输出以下信息。
```
SEND OK
```
说明：
- 若输入的字节数目超过 AT+WSSEND 命令设定的长度 (n)，则系统会响应 busy p...，并发送数据的前 n 个字节，发送完成后响应 SEND OK。
接收 4 字节数据。

由于上面的 WebSocket 服务器是一个回显服务器，因此在数据发送后，服务器也会原样返回该数据，即 AT 会输出：
```
+WS_DATA:0,4,test
```

提供有关此文档的反馈

WebSocket AT 示例

基于 TCP 的 WebSocket 连接

基于 TLS 的 WebSocket 连接（相互鉴权）

基于 TCP 的 WebSocket 连接 