openclaw-elys 1.3.1 → 1.4.0

package/README.md

@@ -0,0 +1,74 @@
+# openclaw-elys
+
+OpenClaw channel plugin for [Elys App](https://elys.ai) — connects your local OpenClaw agent to the Elys mobile app.
+
+Elys App 的 OpenClaw 频道插件 — 将本地 OpenClaw 智能体连接到 Elys 手机应用。
+
+## Install / 安装
+
+```bash
+openclaw plugins install openclaw-elys
+# Installs the latest version by default / 默认安装最新版本
+```
+
+## Setup / 注册设备
+
+Get a one-time register token from the Elys App, then run:
+
+从 Elys App 获取一次性注册令牌，然后执行：
+
+```bash
+npx openclaw-elys setup <gateway_url> <register_token>
+```
+
+Example / 示例：
+
+```bash
+npx openclaw-elys setup https://your-gateway.com reg_abc123def456
+# Device registered successfully!
+#   Device ID:    d_xxxxxxxxxxxx
+#   Credentials saved to ~/.elys/config.json
+#   OpenClaw config updated: channels.elys.gatewayUrl = https://your-gateway.com
+#
+# Restart OpenClaw gateway to activate: openclaw gateway restart
+```
+
+The setup command automatically configures `channels.elys` in `~/.openclaw/openclaw.json`.
+
+setup 命令会自动配置 `~/.openclaw/openclaw.json` 中的 `channels.elys`。
+
+Restart the OpenClaw gateway to activate:
+
+重启 OpenClaw 网关以激活：
+
+```bash
+openclaw gateway restart
+```
+
+## Status / 查看状态
+
+```bash
+npx openclaw-elys status
+```
+
+## Uninstall / 卸载
+
+Revoke device credentials and remove local config:
+
+撤销设备凭证并删除本地配置：
+
+```bash
+npx openclaw-elys uninstall
+```
+
+Then remove the plugin:
+
+然后卸载插件：
+
+```bash
+openclaw plugins uninstall openclaw-elys
+```
+
+## License
+
+MIT

package/dist/src/cli.js

@@ -1,6 +1,52 @@
 #!/usr/bin/env node
+import fs from "fs";
+import os from "os";
+import path from "path";
 import { registerDevice } from "./register.js";
 import { loadCredentials, loadGatewayUrl, deleteCredentials, } from "./config.js";
+const OPENCLAW_CONFIG = path.join(os.homedir(), ".openclaw", "openclaw.json");
+/**
+ * Auto-configure channels.elys in ~/.openclaw/openclaw.json
+ */
+function configureOpenClawChannel(gatewayUrl) {
+    try {
+        if (!fs.existsSync(OPENCLAW_CONFIG))
+            return false;
+        const raw = fs.readFileSync(OPENCLAW_CONFIG, "utf-8");
+        const cfg = JSON.parse(raw);
+        if (!cfg.channels)
+            cfg.channels = {};
+        cfg.channels.elys = {
+            enabled: true,
+            gatewayUrl,
+        };
+        fs.writeFileSync(OPENCLAW_CONFIG, JSON.stringify(cfg, null, 2), "utf-8");
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Remove channels.elys from ~/.openclaw/openclaw.json
+ */
+function removeOpenClawChannel() {
+    try {
+        if (!fs.existsSync(OPENCLAW_CONFIG))
+            return false;
+        const raw = fs.readFileSync(OPENCLAW_CONFIG, "utf-8");
+        const cfg = JSON.parse(raw);
+        if (cfg.channels?.elys) {
+            delete cfg.channels.elys;
+            fs.writeFileSync(OPENCLAW_CONFIG, JSON.stringify(cfg, null, 2), "utf-8");
+            return true;
+        }
+        return false;
+    }
+    catch {
+        return false;
+    }
+}
 const args = process.argv.slice(2);
 const command = args[0];
 if (command === "setup") {
@@ -16,8 +62,19 @@ if (command === "setup") {
         .then((creds) => {
         console.log("Device registered successfully!");
         console.log(`  Device ID:    ${creds.deviceId}`);
-        console.log(`  MQTT Broker:  ${creds.mqttBroker}`);
         console.log(`  Credentials saved to ~/.elys/config.json`);
+        // Auto-configure OpenClaw channel
+        if (configureOpenClawChannel(gatewayUrl)) {
+            console.log(`  OpenClaw config updated: channels.elys.gatewayUrl = ${gatewayUrl}`);
+            console.log("");
+            console.log("Restart OpenClaw gateway to activate: openclaw gateway restart");
+        }
+        else {
+            console.log("");
+            console.log("Add to ~/.openclaw/openclaw.json:");
+            console.log(`  "channels": { "elys": { "enabled": true, "gatewayUrl": "${gatewayUrl}" } }`);
+            console.log("Then restart: openclaw gateway restart");
+        }
     })
         .catch((err) => {
         console.error("Registration failed:", err.message);
@@ -35,6 +92,7 @@ else if (command === "uninstall") {
     if (!gatewayUrl) {
         console.log("No gateway URL found. Cleaning up local credentials only.");
         deleteCredentials();
+        removeOpenClawChannel();
         console.log("Local credentials removed.");
         process.exit(0);
     }
@@ -59,6 +117,9 @@ else if (command === "uninstall") {
     })
         .finally(() => {
         deleteCredentials();
+        if (removeOpenClawChannel()) {
+            console.log("OpenClaw channel config removed.");
+        }
         console.log("Local credentials removed.");
     });
 }
@@ -67,7 +128,6 @@ else if (command === "status") {
     if (creds) {
         console.log("Elys device credentials:");
         console.log(`  Device ID:    ${creds.deviceId}`);
-        console.log(`  MQTT Broker:  ${creds.mqttBroker}`);
         console.log(`  Config file:  ~/.elys/config.json`);
     }
     else {

package/dist/src/monitor.d.ts

@@ -5,7 +5,7 @@ export interface MonitorElysOpts {
     accountId?: string;
     channelRuntime?: ChannelRuntimeReply;
 }
-/** Subset of OpenClaw's channelRuntime.reply API that we use */
+/** Subset of OpenClaw's PluginRuntime["channel"] that we use */
 type ReplyPayload = {
     text?: string;
     mediaUrl?: string;
@@ -18,9 +18,12 @@ type ChannelRuntimeReply = {
             ctx: Record<string, unknown>;
             cfg: Record<string, unknown>;
             dispatcherOptions: {
-                deliver: (payload: ReplyPayload) => Promise<void>;
-                deliverBlock?: (payload: ReplyPayload) => Promise<void>;
-                deliverToolResult?: (payload: ReplyPayload) => Promise<void>;
+                deliver: (payload: ReplyPayload, info: {
+                    kind: "tool" | "block" | "final";
+                }) => Promise<void>;
+                onError?: (err: unknown, info: {
+                    kind: string;
+                }) => void;
             };
             replyOptions?: Record<string, unknown>;
         }) => Promise<{

package/dist/src/monitor.js

@@ -30,6 +30,7 @@ export async function monitorElysProvider(opts) {
     const channelRuntime = opts.channelRuntime;
     const dispatchReply = channelRuntime?.reply?.dispatchReplyWithBufferedBlockDispatcher;
     const finalizeCtx = channelRuntime?.reply?.finalizeInboundContext;
+    log(`[elys] channelRuntime available: ${!!channelRuntime}, dispatchReply: ${!!dispatchReply}, finalizeCtx: ${!!finalizeCtx}`);
     const commandHandler = async (cmd) => {
         log(`[elys] executing command: ${cmd.command}`, cmd.args);
         // If we have the full OpenClaw channelRuntime, use the standard dispatch path
@@ -51,37 +52,36 @@ export async function monitorElysProvider(opts) {
                     AccountId: "default",
                     SessionKey: `elys:${credentials.deviceId}`,
                     CommandAuthorized: true,
+                    OriginatingChannel: "elys",
+                    OriginatingTo: credentials.deviceId,
                 });
                 await dispatchReply({
                     ctx: inboundCtx,
                     cfg: opts.config,
                     dispatcherOptions: {
-                        // Block (streaming) delivery — send each chunk via MQTT
-                        deliverBlock: async (payload) => {
+                        // Single deliver callback with kind discriminator (matches OpenClaw API)
+                        deliver: async (payload, info) => {
                             if (payload.text) {
                                 fullText += payload.text;
                                 seq++;
-                                mqttClient.publishStreamChunk(cmd.id, payload.text, seq, false);
-                                log(`[elys] stream chunk #${seq}: ${payload.text.slice(0, 80)}...`);
+                                const done = info.kind === "final";
+                                mqttClient.publishStreamChunk(cmd.id, payload.text, seq, done);
+                                if (info.kind === "block") {
+                                    log(`[elys] stream chunk #${seq}: ${payload.text.slice(0, 80)}...`);
+                                }
+                                else if (info.kind === "final") {
+                                    log(`[elys] final reply delivered`);
+                                }
                             }
-                        },
-                        // Final delivery
-                        deliver: async (payload) => {
-                            if (payload.text) {
-                                fullText += payload.text;
-                            }
-                            // Send final stream marker
-                            seq++;
-                            mqttClient.publishStreamChunk(cmd.id, payload.text ?? "", seq, true);
-                            log(`[elys] final reply delivered`);
-                        },
-                        // Tool result delivery (optional)
-                        deliverToolResult: async (payload) => {
-                            if (payload.text) {
+                            else if (info.kind === "final") {
                                 seq++;
-                                mqttClient.publishStreamChunk(cmd.id, payload.text, seq, false);
+                                mqttClient.publishStreamChunk(cmd.id, "", seq, true);
+                                log(`[elys] final reply delivered (empty)`);
                             }
                         },
+                        onError: (err, info) => {
+                            log(`[elys] dispatch error (${info.kind}):`, err);
+                        },
                     },
                 });
                 return {
@@ -93,6 +93,7 @@ export async function monitorElysProvider(opts) {
                 };
             }
             catch (err) {
+                log(`[elys] dispatch error:`, err);
                 return {
                     id: cmd.id,
                     type: "result",
@@ -103,6 +104,7 @@ export async function monitorElysProvider(opts) {
             }
         }
         // Fallback: echo the command back (no channelRuntime available)
+        log(`[elys] no channelRuntime — using fallback echo handler`);
         return {
             id: cmd.id,
             type: "result",
@@ -121,6 +123,9 @@ export async function monitorElysProvider(opts) {
     }
 }
 function formatCommandAsText(cmd) {
+    if (cmd.args?.text && typeof cmd.args.text === "string") {
+        return cmd.args.text;
+    }
     const parts = [cmd.command];
     if (cmd.args) {
         for (const [k, v] of Object.entries(cmd.args)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openclaw-elys",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "OpenClaw Elys channel plugin — connects to Elys App",
   "type": "module",
   "main": "dist/index.js",