WebSocket API
WebSocket API 用于接收设备事件、刷新单个设备状态,以及在同一长连接上执行设备操作。
适合使用 WebSocket
- 持续感知设备上线、离线、断电和外设状态变化
- 用户主动刷新单个设备的实时状态
- 在已有长连接中控制继电器或执行 RS485 操作
- 减少高频 HTTP 状态轮询
设备列表、分页查询、设备配置读取和命令结果查询仍使用 REST API。详细选型参见 REST API 与 WebSocket。
接入步骤
- 使用 access token 调用
POST /wlte/v1/ws/ticket。 - 使用一次性 ticket 连接
GET /wlte/v1/ws?ticket={ticket}。 - 启动 Ping/Pong 和
session.ping。 - 监听设备事件。
- 使用
device.state.get查询单个设备状态。 - 使用
device.operation.execute执行设备操作。
核心规则
request和reply通过requestId关联。- 设备写操作通过
operation.name区分。 - 回复使用
code、message和可选data,与 REST 响应语义一致。 - 事件没有历史回放;断线重连后应查询关键设备状态。
- 配置变化不广播。当前点动时长和 RS485 波特率通过 REST 查询设备配置。
从 WebSocket 使用范围 查看当前支持的主题和操作。
