@z-qinghui/migpt-claw 1.0.0

package/openclaw.plugin.json

@@ -0,0 +1,344 @@
+{
+  "id": "migpt-claw",
+  "name": "MiGPT Channel",
+  "description": "小米小爱音箱 OpenClaw Channel 插件，让小爱音箱成为你的龙虾语音助手",
+  "version": "1.0.0",
+  "kind": "channel",
+  "channels": ["migpt"],
+  "skills": ["./skills/migpt-volume"],
+  "author": {
+    "name": "z-qinghui",
+    "url": "https://github.com/z-qinghui"
+  },
+  "homepage": "https://github.com/z-qinghui/migpt-claw",
+  "repository": "https://github.com/z-qinghui/migpt-claw",
+  "license": "MIT",
+  "keywords": ["xiaomi", "mi-gpt", "mico", "speaker", "channel", "voice"],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "userId": {
+        "type": "string",
+        "description": "小米账号 ID"
+      },
+      "password": {
+        "type": "string",
+        "description": "小米账号密码"
+      },
+      "passToken": {
+        "type": "string",
+        "description": "小米 PassToken（可选，如果提供则不需要密码）"
+      },
+      "devices": {
+        "type": "array",
+        "items": { "type": "string" },
+        "description": "设备名称列表"
+      },
+      "systemPrompt": {
+        "type": "string",
+        "description": "系统提示词，用于定制 AI 在音箱场景下的行为规范"
+      },
+      "heartbeat": {
+        "type": "number",
+        "description": "消息轮询间隔（毫秒）",
+        "default": 1000
+      },
+      "speakerControl": {
+        "type": "string",
+        "enum": ["mina", "miot"],
+        "description": "音箱控制方式"
+      },
+      "announceOnStart": {
+        "type": "boolean",
+        "description": "启动时是否播报上线文案",
+        "default": false
+      },
+      "startupMessage": {
+        "type": "string",
+        "description": "上线播报文案",
+        "default": "您的小龙虾已上线，随时为您服务"
+      },
+      "acknowledgeOnReceive": {
+        "type": "boolean",
+        "description": "收到消息时是否回复收到",
+        "default": false
+      },
+      "receiveMessage": {
+        "type": "string",
+        "description": "收到消息回复文案",
+        "default": "收到，处理中"
+      },
+      "keepAlive": {
+        "type": "boolean",
+        "description": "是否默认开启持续对话模式（一次唤醒，连续对话）",
+        "default": false
+      },
+      "keepAliveTimeout": {
+        "type": "number",
+        "description": "持续对话超时时间（秒），超时后自动退出持续对话",
+        "default": 30
+      },
+      "keepAliveEnterKeywords": {
+        "type": "array",
+        "items": { "type": "string" },
+        "description": "进入持续对话的语音关键词",
+        "default": ["打开连续对话", "进入持续对话"]
+      },
+      "keepAliveExitKeywords": {
+        "type": "array",
+        "items": { "type": "string" },
+        "description": "退出持续对话的语音关键词",
+        "default": ["关闭连续对话", "退出持续对话", "再见"]
+      },
+      "hardwareControlVerbs": {
+        "type": "array",
+        "items": { "type": "string" },
+        "description": "硬件控制指令动词关键词，匹配到的指令将跳过 AI 处理，由小爱原生处理",
+        "default": [
+          "播放", "打开", "关闭", "暂停", "继续", "停止", "切换",
+          "开启", "关掉", "开", "关", "启动", "调节",
+          "调高", "调低", "调大", "调小", "调亮", "调暗", "增大", "减小", "设置", "调到",
+          "导航", "拨打", "打电话", "呼叫", "发短信", "发消息"
+        ]
+      },
+      "mimo": {
+        "type": "object",
+        "description": "MiMo-V2.5-TT 自定义 TTS 配置",
+        "properties": {
+          "apiKey": {
+            "type": "string",
+            "description": "MiMo API Key"
+          },
+          "baseUrl": {
+            "type": "string",
+            "description": "MiMo API Base URL",
+            "default": "https://api.xiaomimimo.com/v1"
+          },
+          "model": {
+            "type": "string",
+            "description": "TTS 模型",
+            "enum": ["mimo-v2.5-tts", "mimo-v2.5-tts-voicedesign", "mimo-v2.5-tts-voiceclone"],
+            "default": "mimo-v2.5-tts"
+          },
+          "voice": {
+            "type": "string",
+            "description": "预设音色 ID（如 mimo_default, 冰糖, 茉莉, 苏打, 白桦, Mia, Chloe）",
+            "default": "mimo_default"
+          },
+          "style": {
+            "type": "string",
+            "description": "风格指令（如 温柔, 活泼, 磁性, 甜美 等）"
+          },
+          "stream": {
+            "type": "boolean",
+            "description": "启用流式传输（降低首字延迟）",
+            "default": true
+          },
+          "port": {
+            "type": "number",
+            "description": "TTS 服务器固定端口（0 = 随机分配，云服务器建议固定端口以便开放防火墙）",
+            "default": 0
+          },
+          "host": {
+            "type": "string",
+            "description": "TTS 服务器监听地址",
+            "default": "0.0.0.0"
+          }
+        },
+        "required": ["apiKey"]
+      }
+    }
+  },
+  "uiHints": {
+    "userId": {
+      "label": "小米账号 ID",
+      "placeholder": "请输入小米账号"
+    },
+    "password": {
+      "label": "密码",
+      "sensitive": true,
+      "placeholder": "请输入小米账号密码"
+    },
+    "passToken": {
+      "label": "PassToken",
+      "sensitive": true,
+      "placeholder": "可选，如果提供则不需要密码"
+    },
+    "devices": {
+      "label": "设备列表",
+      "placeholder": "客厅音箱，卧室音箱"
+    },
+    "systemPrompt": {
+      "label": "系统提示词",
+      "placeholder": "自定义 AI 在音箱场景下的行为规范"
+    },
+    "heartbeat": {
+      "label": "轮询间隔",
+      "placeholder": "1000"
+    },
+    "speakerControl": {
+      "label": "控制方式",
+      "placeholder": "mina 或 miot"
+    },
+    "announceOnStart": {
+      "label": "启动时播报",
+      "description": "启用后，音箱启动时会播报上线文案"
+    },
+    "startupMessage": {
+      "label": "上线文案",
+      "placeholder": "您的小龙虾已上线，随时为您服务"
+    },
+    "acknowledgeOnReceive": {
+      "label": "收到消息回复",
+      "description": "启用后，收到消息时会播放提示音"
+    },
+    "receiveMessage": {
+      "label": "回复文案",
+      "placeholder": "收到，处理中"
+    },
+    "keepAlive": {
+      "label": "持续对话",
+      "description": "启用后，一次唤醒可连续对话，无需重复唤醒"
+    },
+    "keepAliveTimeout": {
+      "label": "持续对话超时",
+      "placeholder": "30"
+    },
+    "keepAliveEnterKeywords": {
+      "label": "进入持续对话关键词",
+      "placeholder": "打开连续对话，进入持续对话"
+    },
+    "keepAliveExitKeywords": {
+      "label": "退出持续对话关键词",
+      "placeholder": "关闭连续对话，退出持续对话，再见"
+    },
+    "hardwareControlVerbs": {
+      "label": "硬件控制指令关键词",
+      "placeholder": "播放，打开，关闭，暂停，调高，调低，调亮，调暗..."
+    },
+    "mimo": {
+      "label": "MiMo TTS",
+      "description": "小米 MiMo-V2.5-TT 自定义语音合成配置"
+    }
+  },
+  "channelConfigs": {
+    "migpt": {
+      "schema": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "启用频道"
+        },
+        "userId": {
+          "type": "string",
+          "description": "小米账号 ID"
+        },
+        "password": {
+          "type": "string",
+          "description": "小米账号密码"
+        },
+        "passToken": {
+          "type": "string",
+          "description": "小米 PassToken（可选，如果提供则不需要密码）"
+        },
+        "devices": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "设备名称列表"
+        },
+        "systemPrompt": {
+          "type": "string",
+          "description": "系统提示词，用于定制 AI 在音箱场景下的行为规范"
+        },
+        "heartbeat": {
+          "type": "number",
+          "description": "消息轮询间隔（毫秒）",
+          "default": 1000
+        },
+        "speakerControl": {
+          "type": "string",
+          "enum": ["mina", "miot"],
+          "description": "音箱控制方式"
+        },
+        "announceOnStart": {
+          "type": "boolean",
+          "description": "启动时是否播报上线文案",
+          "default": false
+        },
+        "startupMessage": {
+          "type": "string",
+          "description": "上线播报文案",
+          "default": "您的小龙虾已上线，随时为您服务"
+        },
+        "acknowledgeOnReceive": {
+          "type": "boolean",
+          "description": "收到消息时是否回复收到",
+          "default": false
+        },
+        "receiveMessage": {
+          "type": "string",
+          "description": "收到消息回复文案",
+          "default": "收到，处理中"
+        },
+        "keepAlive": {
+          "type": "boolean",
+          "description": "是否默认开启持续对话模式",
+          "default": false
+        },
+        "keepAliveTimeout": {
+          "type": "number",
+          "description": "持续对话超时时间（秒）",
+          "default": 30
+        },
+        "keepAliveEnterKeywords": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "进入持续对话的语音关键词",
+          "default": ["打开连续对话", "进入持续对话"]
+        },
+        "keepAliveExitKeywords": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "退出持续对话的语音关键词",
+          "default": ["关闭连续对话", "退出持续对话", "再见"]
+        },
+        "hardwareControlVerbs": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "硬件控制指令动词关键词，匹配到的指令将跳过 AI 处理，由小爱原生处理",
+          "default": [
+            "播放", "打开", "关闭", "暂停", "继续", "停止", "切换",
+            "开启", "关掉", "开", "关", "启动", "调节",
+            "调高", "调低", "调大", "调小", "调亮", "调暗", "增大", "减小", "设置", "调到",
+            "导航", "拨打", "打电话", "呼叫", "发短信", "发消息"
+          ]
+        },
+        "streaming": {
+          "type": "boolean",
+          "description": "启用流式输出"
+        },
+        "mimo": {
+           "type": "object",
+           "description": "MiMo-V2.5-TT 自定义 TTS 配置",
+           "properties": {
+             "apiKey": { "type": "string", "description": "MiMo API Key" },
+             "baseUrl": { "type": "string", "description": "MiMo API Base URL", "default": "https://api.xiaomimimo.com/v1" },
+             "model": { "type": "string", "enum": ["mimo-v2.5-tts", "mimo-v2.5-tts-voicedesign", "mimo-v2.5-tts-voiceclone"], "default": "mimo-v2.5-tts" },
+             "voice": { "type": "string", "description": "预设音色 ID", "default": "mimo_default" },
+             "style": { "type": "string", "description": "风格指令" },
+             "stream": { "type": "boolean", "description": "启用流式传输", "default": true },
+             "port": { "type": "number", "description": "TTS 服务器固定端口（0=随机）", "default": 0 },
+             "host": { "type": "string", "description": "TTS 服务器监听地址", "default": "0.0.0.0" }
+           },
+           "required": ["apiKey"]
+         }
+        }
+      },
+      "label": "MiGPT",
+      "description": "小米小爱音箱语音对话 Channel"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,106 @@
+{
+  "version": "1.0.0",
+  "name": "@z-qinghui/migpt-claw",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "小米小爱音箱 OpenClaw Channel 插件",
+  "keywords": [
+    "openclaw",
+    "xiaomi",
+    "mi-gpt",
+    "mico",
+    "channel"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "npm run build",
+    "prepack": "npm run build"
+  },
+  "files": [
+    "dist",
+    "src",
+    "index.ts",
+    "setup-entry.ts",
+    "skills",
+    "openclaw.plugin.json",
+    "tsconfig.json"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js"
+    }
+  },
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ],
+    "setupEntry": "./setup-entry.ts",
+    "channel": {
+      "id": "migpt",
+      "label": "MiGPT",
+      "selectionLabel": "小米音箱 (MiGPT)",
+      "blurb": "小米小爱音箱语音对话，让小爱音箱成为你的龙虾语音助手",
+      "docsPath": "/channels/migpt",
+      "docsLabel": "MiGPT 文档",
+      "order": 60,
+      "aliases": ["xiaomi", "mico"],
+      "markdownCapable": false,
+      "exposure": {
+        "configured": true,
+        "setup": true,
+        "docs": true
+      }
+    },
+    "install": {
+      "clawhubSpec": "@z-qinghui/migpt-claw",
+      "npmSpec": "@z-qinghui/migpt-claw",
+      "defaultChoice": "clawhub",
+      "minHostVersion": ">=0.1.0"
+    },
+    "startup": {
+      "deferConfiguredChannelFullLoadUntilAfterListen": true
+    }
+  },
+  "compat": {
+    "pluginApi": ">=0.1.0",
+    "minHostVersion": ">=0.1.0"
+  },
+  "build": {
+    "openclawVersion": "0.1.0",
+    "pluginSdkVersion": "0.1.0"
+  },
+  "dependencies": {
+    "axios": "^1.13.6",
+    "node-fetch": "^3.3.2",
+    "pako": "^2.1.0"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.9.36",
+    "@types/node": "^22.14.0",
+    "@types/pako": "^2.0.4",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
+  "license": "MIT",
+  "author": {
+    "name": "z-qinghui",
+    "url": "https://github.com/z-qinghui"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/z-qinghui/migpt-claw.git"
+  }
+}

package/setup-entry.ts

@@ -0,0 +1,12 @@
+/**
+ * setup-entry.ts — 轻量级 Setup 入口
+ *
+ * OpenClaw 在以下场景仅加载此文件（不加载完整 index.ts）：
+ * - 频道已禁用但需要 setup 界面（onboarding、config repair）
+ * - 频道已启用但未配置
+ * - 延迟加载模式下，gateway 启动前仅需 setup 表面
+ */
+import { defineSetupPluginEntry } from 'openclaw/plugin-sdk/channel-core';
+import { miGPTPlugin } from './src/channel.js';
+
+export default defineSetupPluginEntry(miGPTPlugin);

package/skills/migpt-volume/SKILL.md

@@ -0,0 +1,182 @@
+# MiGPT 音箱插件 - 提示词定制指南
+
+## 概述
+
+MiGPT 音箱插件支持通过 `systemPrompt` 配置项定制 AI 在音箱场景下的行为规范。由于音箱通过语音播报，不适合播放长文本、代码、复杂格式等内容，因此需要通过提示词规范 AI 的行为。
+
+## 配置项说明
+
+### 基础配置
+
+| 配置项 | 类型 | 说明 | 默认值 |
+|--------|------|------|--------|
+| `userId` | string | 小米账号 ID | - |
+| `password` | string | 小米账号密码 | - |
+| `passToken` | string | PassToken（可选） | - |
+| `devices` | array | 设备名称列表 | - |
+| `heartbeat` | number | 消息轮询间隔 (ms) | 1000 |
+| `speakerControl` | string | 控制方式 (mina/miot) | - |
+
+### 提示词配置
+
+| 配置项 | 类型 | 说明 | 默认值 |
+|--------|------|------|--------|
+| `systemPrompt` | string | 系统提示词 | 内置默认提示词 |
+
+### 播报控制配置
+
+| 配置项 | 类型 | 说明 | 默认值 |
+|--------|------|------|--------|
+| `announceOnStart` | boolean | 启动时是否播报上线文案 | false |
+| `startupMessage` | string | 上线播报文案 | "您的小龙虾已上线，随时为您服务" |
+| `acknowledgeOnReceive` | boolean | 收到消息时是否回复收到 | false |
+| `receiveMessage` | string | 收到消息回复文案 | "收到，处理中" |
+
+## 配置方式
+
+### 1. 全局配置
+
+在 `openclaw.json` 配置文件中设置全局配置：
+
+```json
+{
+  "channels": {
+    "migpt": {
+      "userId": "your-mi-account",
+      "passToken": "your-pass-token",
+      "devices": ["客厅音箱"],
+      "systemPrompt": "你的自定义提示词...",
+      "announceOnStart": true,
+      "startupMessage": "小爱音箱已上线，随时为您服务",
+      "acknowledgeOnReceive": true,
+      "receiveMessage": "收到，请讲"
+    }
+  }
+}
+```
+
+### 2. 账户级别配置
+
+如果配置了多个音箱账户，可以为每个账户单独设置：
+
+```json
+{
+  "channels": {
+    "migpt": {
+      "userId": "your-mi-account",
+      "passToken": "your-pass-token",
+      "devices": ["客厅音箱"],
+      "accounts": {
+        "account1": {
+          "userId": "account1-id",
+          "passToken": "account1-token",
+          "devices": ["卧室音箱"],
+          "systemPrompt": "卧室音箱的专属提示词..."
+        }
+      }
+    }
+  }
+}
+```
+
+## 默认提示词
+
+如果未配置 `systemPrompt`，插件会使用以下默认提示词：
+
+```
+【音箱播报规范 - 必须遵守】
+你是一个智能音箱助手，通过语音与用户交流。请遵守以下规范：
+
+📢 播报原则：
+1. 简短优先：单次播报控制在 100 字以内，超过请拆分或改用其他渠道
+2. 纯文字：只输出适合语音播报的纯文字，不要包含 URL、代码、复杂格式
+3. 自然口语：使用简短、清晰的口语表达，避免长句和复杂结构
+
+🚫 不适合播报的内容（应改用其他渠道）：
+- 代码片段、技术文档
+- 长篇文章、报告（>300 字）
+- 复杂数据表格、列表
+- 图片、视频、文件等多媒体内容
+- URL 链接、邮箱地址
+
+✅ 正确做法示例：
+- 短回复："好的，已为你设置明天早上 8 点的闹钟"
+- 长内容分流："由于内容较长，详细报告已发送到你的手机/微信，请查看"
+- 代码场景："代码已生成并发送到你的邮箱，请注意查收"
+- 多媒体场景："这张图片很有趣，已发送到你的手机查看"
+```
+
+## 自定义提示词示例
+
+### 示例 1：强调分流策略
+
+```
+你是一个智能音箱助手。请遵守：
+1. 简短回复可直接播报（<100 字）
+2. 长内容请说明"已发送到其他渠道"
+3. 代码、文档、图片等内容不要尝试播报，告知用户已发送
+4. 使用友好、自然的口语表达
+```
+
+### 示例 2：特定场景定制
+
+```
+你是家庭助手小爱，通过音箱与家人交流：
+- 天气、时间、提醒等简单信息直接播报
+- 新闻、文章等长内容只播报摘要，详情发送手机
+- 涉及视觉内容（图片、视频）告知用户已发送到手机
+- 保持亲切、简洁的家人式对话风格
+```
+
+### 示例 3：多渠道协作
+
+```
+音箱播报规范：
+1. 优先判断内容是否适合语音播报
+2. 适合播报：简短文字、确认信息、简单问答
+3. 不适合播报：代码、长文、数据、多媒体 → 使用框架的其他 Channel 发送
+4. 分流时告知用户："由于 XXX 原因，已发送到 XXX，请查看"
+```
+
+## 工作原理
+
+1. **消息接收**：音箱收到用户语音后，转录为文字
+2. **提示词注入**：将 `systemPrompt` 注入到 AI 的上下文中
+3. **AI 处理**：AI 根据提示词规范生成适合播报的回复
+4. **分流决策**：
+   - 短文本 → 通过 `deliver` 回调播放
+   - 长内容/多媒体 → AI 应说明已使用其他渠道发送
+
+## 与其他 Channel 协作
+
+音箱插件可以与其他 Channel（如微信、QQ、邮件等）配合使用：
+
+```json
+{
+  "channels": {
+    "migpt": {
+      "systemPrompt": "长内容请发送到用户的微信"
+    },
+    "wechat": {
+      // 微信 Channel 配置
+    }
+  }
+}
+```
+
+AI 会根据提示词判断：
+- 简单回复 → 音箱播报
+- 复杂内容 → 通过微信发送，音箱告知用户
+
+## 最佳实践
+
+1. **保持简短**：提示词本身也应简洁，避免过度复杂
+2. **明确分流**：清楚说明什么内容适合播报，什么应分流
+3. **友好提示**：分流时告知用户原因和发送目标
+4. **测试调整**：根据实际使用效果调整提示词
+
+## 注意事项
+
+- 提示词优先级：账户级别 > 全局级别
+- 提示词会在每条消息处理时注入到 AI 上下文
+- 过长的提示词会占用 AI 上下文空间，建议控制在 500 字以内

package/skills/migpt-volume/index.ts

@@ -0,0 +1,50 @@
+import type { OpenClawPluginApi } from 'openclaw/plugin-sdk';
+import { MiService } from '../../service.js';
+import { MiSpeaker } from '../../speaker.js';
+
+/**
+ * 音量控制技能
+ */
+export function registerMigptVolumeSkill(api: OpenClawPluginApi) {
+  api.registerTool({
+    name: 'set_volume',
+    description: '设置小爱音箱的音量',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        volume: {
+          type: 'number',
+          description: '音量大小（6-100）',
+          minimum: 6,
+          maximum: 100,
+        },
+      },
+      required: ['volume'],
+    },
+    execute: async (input: { volume: number }) => {
+      const result = await MiSpeaker.setVolume(input.volume);
+      if (result.success) {
+        return { success: true, message: `音量已设置为 ${input.volume}` };
+      } else {
+        return { success: false, error: result.error };
+      }
+    },
+  });
+
+  api.registerTool({
+    name: 'get_volume',
+    description: '获取小爱音箱的当前音量',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+    execute: async () => {
+      const volume = await MiSpeaker.getVolume();
+      if (volume !== undefined) {
+        return { success: true, volume };
+      } else {
+        return { success: false, error: '获取音量失败' };
+      }
+    },
+  });
+}