sk-voice-command 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 sk-voice-command
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,402 @@
+# sk-voice-command
+
+> 阿里云语音识别指令模块 for uni-app
+
+一个零依赖的 Vue 2 语音指令模块，基于阿里云实时语音识别技术，让你的 uni-app 应用支持语音控制。
+
+## ✨ 特性
+
+- 🎤 **实时语音识别** - 基于阿里云"一句话识别"，低延迟高准确率
+- 🎯 **智能指令匹配** - 支持模糊匹配，自动识别用户意图
+- 🔌 **零依赖** - 不依赖 Vuex、uni-ui 等第三方库
+- 📦 **即插即用** - 5 分钟完成集成
+- 📱 **跨平台** - 支持微信小程序、H5、App
+
+## 📦 安装
+
+```bash
+npm install sk-voice-command
+```
+
+## 🚀 快速开始
+
+### 1. 安装插件
+
+在 `main.js` 中注册插件：
+
+```javascript
+import Vue from 'vue'
+import SkVoiceCommand from 'sk-voice-command'
+
+Vue.use(SkVoiceCommand, {
+  // 必需配置
+  appkey: 'your-aliyun-appkey',
+  tokenUrl: 'https://your-api.com/api/aliyun/token',
+
+  // 可选配置
+  matchThreshold: 0.8,           // 匹配阈值（默认 0.8）
+  confirmThreshold: 0.6,         // 确认阈值（默认 0.6）
+  enableIntermediateResult: true,// 启用中间结果（默认 true）
+  debug: false                   // 调试模式（默认 false）
+})
+```
+
+### 2. 注册指令
+
+在页面组件中注册指令：
+
+```javascript
+export default {
+  mounted() {
+    // 注册页面级指令
+    this.$voice.registerCommands({
+      scope: 'page',
+      commands: [
+        {
+          id: 'submit-form',
+          keywords: ['提交', '确认提交', '发送'],
+          action: () => {
+            this.submitForm()
+          },
+          description: '提交当前表单'
+        },
+        {
+          id: 'scroll-top',
+          keywords: ['滚动到顶部', '回到顶部'],
+          action: () => {
+            uni.pageScrollTo({ scrollTop: 0 })
+          },
+          description: '滚动到页面顶部'
+        }
+      ]
+    })
+  },
+
+  beforeDestroy() {
+    // 页面卸载时自动清除指令（插件会自动处理，也可以手动调用）
+    // this.$voice.unregisterCommands('page')
+  }
+}
+```
+
+### 3. 使用
+
+```javascript
+export default {
+  methods: {
+    // 开始录音
+    async startVoice() {
+      try {
+        await this.$voice.start()
+        console.log('开始录音')
+      } catch (error) {
+        console.error('启动失败:', error)
+      }
+    },
+
+    // 停止录音
+    async stopVoice() {
+      const result = await this.$voice.stop()
+      console.log('识别结果:', result)
+      // result.text - 识别文本
+      // result.matched - 是否匹配到指令
+      // result.command - 匹配的指令
+      // result.similarity - 相似度
+    },
+
+    // 手动匹配指令（用于测试）
+    testMatch(text) {
+      const result = this.$voice.matchCommand(text)
+      if (result.matched) {
+        this.$voice.executeCommand(result.command)
+      }
+    }
+  }
+}
+```
+
+## 📚 API 文档
+
+### 插件配置选项
+
+| 参数 | 类型 | 必需 | 默认值 | 说明 |
+|------|------|------|--------|------|
+| appkey | String | ✅ | - | 阿里云 AppKey |
+| tokenUrl | String | ✅ | - | Token 获取接口地址 |
+| matchThreshold | Number | ❌ | 0.8 | 自动执行阈值（0-1） |
+| confirmThreshold | Number | ❌ | 0.6 | 确认执行阈值（0-1） |
+| enableIntermediateResult | Boolean | ❌ | true | 是否启用中间结果 |
+| debug | Boolean | ❌ | false | 调试模式 |
+
+### 实例方法
+
+#### registerCommands(options)
+
+注册指令
+
+```javascript
+this.$voice.registerCommands({
+  scope: 'page', // 'page' 或 'global'
+  commands: [
+    {
+      id: 'command-id',           // 唯一标识（必需）
+      keywords: ['关键词1', '关键词2'], // 关键词数组（必需）
+      action: () => {},            // 执行函数（必需）
+      description: '指令描述',      // 描述（可选）
+      weight: 10                   // 权重（可选，默认 0）
+    }
+  ]
+})
+```
+
+#### unregisterCommands(scope)
+
+注销指令
+
+```javascript
+this.$voice.unregisterCommands('page') // 注销页面指令
+this.$voice.unregisterCommands('global') // 注销全局指令
+```
+
+#### start()
+
+开始语音识别
+
+```javascript
+await this.$voice.start()
+```
+
+#### stop()
+
+停止语音识别
+
+```javascript
+const result = await this.$voice.stop()
+// result.text - 识别文本
+// result.matched - 是否匹配
+// result.command - 匹配的指令
+// result.similarity - 相似度（0-1）
+// result.weight - 指令权重
+// result.action - 'auto' | 'confirm' | 'reject'
+// result.matchedKeyword - 匹配的关键词
+// result.allMatches - 所有匹配结果（调试用）
+```
+
+#### matchCommand(text)
+
+手动匹配指令（用于测试）
+
+```javascript
+const result = this.$voice.matchCommand('测试文本')
+if (result.matched) {
+  this.$voice.executeCommand(result.command)
+}
+```
+
+#### executeCommand(command)
+
+执行指令
+
+```javascript
+this.$voice.executeCommand(command)
+```
+
+### 状态对象
+
+通过 `this.$voice.state` 访问：
+
+```javascript
+{
+  isRecording: false,        // 是否正在录音
+  recognitionText: '',       // 识别文本
+  lastCommand: null,         // 最后执行的指令
+  error: null,               // 错误信息
+  status: 'idle',            // 当前状态
+  recordDuration: 0,         // 录音时长（毫秒）
+  isRecognizing: false       // 是否正在识别
+}
+```
+
+### 事件监听
+
+```javascript
+// 监听状态变化
+this.$voice.on('state-change', (state) => {
+  console.log('状态变化:', state)
+})
+
+// 监听录音开始
+this.$voice.on('recording-started', () => {
+  console.log('开始录音')
+})
+
+// 监听录音停止
+this.$voice.on('recording-stopped', (result) => {
+  console.log('识别结果:', result)
+})
+
+// 移除监听
+this.$voice.off('state-change', callback)
+```
+
+## 🔧 高级用法
+
+### 全局指令
+
+在 `App.vue` 中注册全局指令：
+
+```javascript
+export default {
+  onLaunch() {
+    this.$voice.registerCommands({
+      scope: 'global',
+      commands: [
+        {
+          id: 'go-home',
+          keywords: ['返回首页', '回到主页'],
+          action: () => {
+            uni.switchTab({ url: '/pages/index/index' })
+          },
+          description: '返回首页'
+        }
+      ]
+    })
+  }
+}
+```
+
+### 指令优先级
+
+- **页面指令 > 全局指令**
+- 当页面指令和全局指令有相同关键词时，优先执行页面指令
+- **权重优先级**：当多个指令相似度相同或相近（差异 ≤ 5%）时，优先执行权重高的指令
+
+### 匹配策略
+
+- **相似度 ≥ 80%**: 自动执行
+- **60% ≤ 相似度 < 80%**: 弹出确认对话框
+- **相似度 < 60%**: 提示未识别，不执行
+
+### 权重系统
+
+权重用于处理多个指令相似度接近的情况：
+
+```javascript
+// 示例：三个指令相似度都在 85%-90% 之间
+{
+  id: 'command-a',
+  keywords: ['提交'],
+  action: () => console.log('A'),
+  weight: 10  // 权重最高，优先执行
+}
+
+{
+  id: 'command-b',
+  keywords: ['确认'],
+  action: () => console.log('B'),
+  weight: 5
+}
+
+{
+  id: 'command-c',
+  keywords: ['发送'],
+  action: () => console.log('C'),
+  weight: 8
+}
+```
+
+**权重规则**：
+1. 默认权重为 0
+2. 当多个指令相似度差异 ≤ 5% 时，按权重降序排列
+3. 权重越高，优先级越高
+
+## 📝 配置 Token 获取接口
+
+模块需要提供一个 Token 获取接口，返回阿里云访问 Token：
+
+```javascript
+// 示例：后端接口
+GET /api/aliyun/token
+
+Response:
+{
+  "token": "your-aliyun-token"
+}
+```
+
+后端实现示例（Node.js）：
+
+```javascript
+const Core = require('@alicloud/pop-core')
+
+// 获取 Token
+async function getToken() {
+  const client = new Core({
+    accessKeyId: process.env.ALIYUN_ACCESS_KEY_ID,
+    accessKeySecret: process.env.ALIYUN_ACCESS_KEY_SECRET,
+    endpoint: 'https://nls-meta.cn-shanghai.aliyuncs.com',
+    apiVersion: '2019-02-28'
+  })
+
+  const params = {
+    "Action": "CreateToken"
+  }
+
+  const result = await client.request('POST', params)
+  return result.Token.Id
+}
+```
+
+## 🌐 微信小程序配置
+
+在微信小程序后台配置以下合法域名：
+
+```
+request: https://nls-meta.cn-shanghai.aliyuncs.com
+socket: wss://nls-gateway-cn-shanghai.aliyuncs.com
+```
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+## 📄 许可证
+
+[MIT](LICENSE)
+
+## 🔗 相关链接
+
+- [阿里云智能语音交互](https://www.aliyun.com/product/ivh)
+- [uni-app 官方文档](https://uniapp.dcloud.io/)
+- [OpenSpec 提案](../../openspec/changes/add-aliyun-voice-command/)
+
+## 💡 常见问题
+
+### 1. 如何获取阿里云 AppKey？
+
+1. 访问 [阿里云控制台](https://ecs.console.aliyun.com/)
+2. 开通"智能语音交互"服务
+3. 创建项目并获取 AppKey
+
+### 2. Token 如何获取？
+
+推荐方式：通过后端接口获取，避免暴露 AccessKey。
+
+开发测试：可以使用 AccessKey 直接获取（不推荐生产环境）。
+
+### 3. 支持哪些平台？
+
+- ✅ 微信小程序
+- ✅ H5
+- ✅ Android App
+- ✅ iOS App
+
+### 4. 指令匹配不准确怎么办？
+
+1. 调整 `matchThreshold` 和 `confirmThreshold` 配置
+2. 为指令添加更多关键词同义词
+3. 启用 `debug: true` 查看匹配详情
+
+---
+
+**Made with ❤️ by sk-voice-command team**

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "sk-voice-command",
+  "version": "1.0.0",
+  "description": "语音指令控制和自动化操作",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "uni-app",
+    "voice",
+    "speech-recognition",
+    "voice-command",
+    "语音识别",
+    "语音指令"
+  ],
+  "author": "Ding_D(1601202253@qq.com)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "files": [
+    "src/",
+    "README.md",
+    "LICENSE"
+  ]
+}