openclaw-elys 1.3.1 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# openclaw-elys
|
|
2
|
+
|
|
3
|
+
OpenClaw channel plugin for [Elys App](https://elys.ai) — connects your local OpenClaw agent to the Elys mobile app via MQTT gateway.
|
|
4
|
+
|
|
5
|
+
Elys App 的 OpenClaw 频道插件 — 通过 MQTT 网关将本地 OpenClaw 智能体连接到 Elys 手机应用。
|
|
6
|
+
|
|
7
|
+
## Install / 安装
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
openclaw plugins install openclaw-elys
|
|
11
|
+
# Installs the latest version by default / 默认安装最新版本
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Setup / 注册设备
|
|
15
|
+
|
|
16
|
+
Get a one-time register token from the Elys App, then run:
|
|
17
|
+
|
|
18
|
+
从 Elys App 获取一次性注册令牌，然后执行：
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx openclaw-elys setup <gateway_url> <register_token>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Example / 示例：
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx openclaw-elys setup https://your-gateway.com reg_abc123def456
|
|
28
|
+
# Device registered successfully!
|
|
29
|
+
# Device ID: d_xxxxxxxxxxxx
|
|
30
|
+
# MQTT Broker: mqtts://xxx.emqxcloud.cn:8883
|
|
31
|
+
# Credentials saved to ~/.elys/config.json
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then add the channel config to your OpenClaw config (`~/.openclaw/openclaw.json`):
|
|
35
|
+
|
|
36
|
+
然后在 OpenClaw 配置文件中添加频道配置：
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"channels": {
|
|
41
|
+
"elys": {
|
|
42
|
+
"enabled": true,
|
|
43
|
+
"gatewayUrl": "https://your-gateway.com"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Restart the OpenClaw gateway to activate:
|
|
50
|
+
|
|
51
|
+
重启 OpenClaw 网关以激活：
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
openclaw gateway restart
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Status / 查看状态
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npx openclaw-elys status
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Uninstall / 卸载
|
|
64
|
+
|
|
65
|
+
Revoke device credentials and remove local config:
|
|
66
|
+
|
|
67
|
+
撤销设备凭证并删除本地配置：
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx openclaw-elys uninstall
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Then remove the plugin:
|
|
74
|
+
|
|
75
|
+
然后卸载插件：
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
openclaw plugins uninstall openclaw-elys
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## How it works / 工作原理
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Elys App -> Backend -> Gateway (HTTP) -> EMQX (MQTT) -> OpenClaw Plugin
|
|
85
|
+
|
|
|
86
|
+
OpenClaw Plugin -> EMQX (MQTT) -> Gateway -> Backend -> Elys App
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
- **Downlink** / 下行 (App -> Device): Backend calls Gateway HTTP API, Gateway publishes to MQTT
|
|
90
|
+
- **Uplink** / 上行 (Device -> App): Plugin publishes to MQTT, Gateway receives and returns to Backend
|
|
91
|
+
- **Streaming** / 流式: Plugin sends AI reply chunks in real-time via MQTT stream messages
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
MIT
|