@xiaozhi-pro/openclaw-plugin
v1.0.23
Published
小智Pro (XiaoZhi Pro) channel plugin for OpenClaw via WebSocket
Readme
@xiaozhi-pro/openclaw-plugin
小智Pro (XiaoZhi Pro) 通道插件,通过 WebSocket 将小智Pro平台接入 OpenClaw。
OpenClaw 端使用
安装
openclaw plugins install @xiaozhi-pro/openclaw-plugin如果使用国内 npm 镜像导致 404,先临时切到官方源,装完切回:
npm config set registry https://registry.npmjs.org openclaw plugins install @xiaozhi-pro/openclaw-plugin npm config set registry https://registry.npmmirror.com如果仍然失败,可以直接下载 tgz 包本地安装:
wget https://registry.npmjs.org/@xiaozhi-pro/openclaw-plugin/-/openclaw-plugin-1.0.0.tgz openclaw plugins install ./openclaw-plugin-1.0.0.tgz
更新
如果已经安装过,需更新到最新版本:
openclaw plugins install @xiaozhi-pro/openclaw-plugin --force配置
编辑 openclaw.json:
{
"channels": {
"xiaozhi-pro": {
"token": "你的小智Pro平台API密钥"
}
}
}或通过环境变量 XIAOZHI_PRO_TOKEN 设置。
启动
openclaw gateway run插件会自动连接小智Pro WS 服务端,完成认证后进入双向通信。
WS 协议
| 方向 | type | 关键字段 |
|------|------|----------|
| 插件 → 服务端 | auth | token |
| 服务端 → 插件 | auth_ok | user_id |
| 服务端 → 插件 | auth_fail | error, message |
| 服务端 → 插件 | message | user_id, device_id, text, message_id |
| 插件 → 服务端 | response | text, to, user_id, device_id, message_id, subtype? |
| 服务端 → 插件 | ping | timestamp |
| 插件 → 服务端 | pong | — |
开发
pnpm install
pnpm run build修改 wss 地址:
// src/index.ts
const WS_URL = "ws://47.115.76.183:7507/api/v1/openclaw_server/ws";
const WS_URL = "wss://upldapuxqzmh.sealosbja.site/api/v1/openclaw_server/ws";发布
# 发布前需要先提交commit
git add .
git commit -m 'xx'
# 然后更新版本号,本质上打了tag
npm version patch # 1.0.0 → 1.0.1(修bug,最后一位+1)
npm version minor # 1.0.0 → 1.1.0(新功能,中间位+1)
npm version major # 1.0.0 → 2.0.0(破坏性变更,首位+1)
npm run build
npm publish --access public
npm view @xiaozhi-pro/openclaw-plugin # 验证发布成功
# 如果用户用的是国内 npm 镜像(npmmirror.com),刚发布的包还没同步过去,通常需要 10 分钟到几小时。
npm view @xiaozhi-pro/openclaw-plugin --registry https://registry.npmmirror.com删除
npm view @xiaozhi-pro/openclaw-plugin versions
# 只能一个一个删
npm unpublish @xiaozhi-pro/[email protected]许可证
MIT
