# wukong-robot
<p align="center">
<a href="https://wukong.hahack.com" target="_blank">
<img width="128" src="http://hahack-1253537070.file.myqcloud.com/images/wukong-icons/256_256.png" alt="wukong-robot">
</a>
</p>
<p align="center">
wukong-robot 是一个简单、灵活、优雅的中文语音对话机器人/智能音箱项目,目的是让中国的 Maker 和 Haker 们也能快速打造个性化的智能音箱。wukong-robot 还可能是第一个开源的脑机唤醒智能音箱。
</p>
<p align="center">
截至 2023 年 3 月 31 日,wukong-robot 的安装设备数已超过 13,000 台,唤醒次数累积超过了 700,000 次。
</p>
<p align="center">
<a href="https://github.com/users/wzpan/projects/2/views/1"><img alt="wukong-project" src="https://img.shields.io/badge/project-wukong-informational.svg?style=flat-square"></a>
<a href="https://wukong.hahack.com/#/donate"><img alt="捐赠" src="https://img.shields.io/badge/%EF%BF%A5-donate-green.svg?style=flat-square"></a>
<a href="https://travis-ci.org/wzpan/wukong-robot"><img alt="Travis" src="https://img.shields.io/travis/wzpan/wukong-robot.svg?style=flat-square"></a>
<a href="#"><img alt="Python3.7+" src="https://img.shields.io/badge/Python->=3.7-blue.svg?style=flat-square"></a>
<a href="https://hub.docker.com/r/wzpan/wukong-robot"><img alt="docker-pulls" src="https://img.shields.io/docker/pulls/wzpan/wukong-robot.svg?style=flat-square&colorB=success"></a>
<a href="https://github1s.com/wzpan/wukong-robot"><img alt="browse-code" src="https://img.shields.io/badge/browse-code-purple.svg?style=flat-square"></a>
</p>
<p align="center">
<a href="https://opencollective.com/wukong-robot/contribute/tier/8131-sponsor" target="_blank"><img src="https://opencollective.com/wukong-robot/sponsors.svg?avatarHeight=36"></a>
</p>
## Table of Contents
* [特性](#特性)
* [Demo](#demo)
* [环境要求](#环境要求)
* [安装](#安装)
* [升级](#升级)
* [运行](#运行)
* [配置](#配置)
* [技能插件](#插件)
* [API接口](#api-接口)
* [捐赠](#捐赠)
* [贡献](#贡献)
* [引用](#引用)
* [联系](#联系)
* [感谢](#感谢)
* [FAQ](#faq)
* [免责声明](#免责声明)
## 特性
<p align="center">
<img src="https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/wukong-robot-3.3.0.png" alt="wukong-robot">
</p>
* 模块化。功能插件、语音识别、语音合成、对话机器人都做到了高度模块化,第三方插件单独维护,方便继承和开发自己的插件。
* 中文支持。集成百度、科大讯飞、阿里、腾讯、OpenAI Whisper、Apple、微软Edge、VITS声音克隆TTS 等多家中文语音识别和语音合成技术,且可以继续扩展。
* 对话机器人支持。支持基于 [AnyQ](https://wukong.hahack.com/#/anyq) 的本地对话机器人,并支持接入图灵机器人、ChatGPT 等在线对话机器人。
* 全局监听,离线唤醒。支持 [Porcupine](https://github.com/Picovoice/porcupine) 和 [snowboy](https://github.com/Kitt-AI/snowboy) 两套离线语音指令唤醒引擎,并支持 Muse [脑机唤醒](https://wukong.hahack.com/#/bci) 以及行空板摇一摇唤醒等其他唤醒方式。
* 灵活可配置。支持定制机器人名字,支持选择语音识别和合成的插件。
* 智能家居。支持和 [小爱音箱](https://wukong.hahack.com/#/linkage)、[Siri](https://wukong.hahack.com/#/linkage)、mqtt、[HomeAssistant](https://wukong.hahack.com/#/smarthome) 等智能家居协议联动,支持语音控制智能家电。
* 后台配套支持。提供配套后台,可实现远程操控、修改配置和日志查看等功能。
* 开放API。可利用后端开放的API,实现更丰富的功能。
* 安装简单,支持更多平台。相比 dingdang-robot ,舍弃了 PocketSphinx 的离线唤醒方案,安装变得更加简单,代码量更少,更易于维护并且能在 Mac 以及更多 Linux 系统中运行。
wukong-robot 的功能还在不断更新迭代中,详见 [更新说明](https://github.com/wzpan/wukong-robot/wiki/update-notes) 。
wukong-robot 的工作模式:
<p align="center">
<img src="https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/wukong-robot-workflow.png" alt="wukong-robot 的工作模式">
</p>
wukong-robot 被唤醒后,用户的语音指令先经过 ASR 引擎进行 ASR 识别成文本,然后对识别到的文本进行 NLU 解析,再将解析结果进行技能匹配,交给适合处理该指令的技能插件去处理。插件处理完成后,得到的结果再交给 TTS 引擎合成成语音,播放给用户。
虽然一次交互可能包含多次网络请求,不过带来的好处是:每一个环节都可以被修改和定制。而且我认为,到了 5G 时代,音箱的响应速度将不再成为体验问题。可定制和个性化才是未来的主流,而届时 wukong-robot 将会是更好的选择!
## Demo
<p align="center">
<img src="https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/user-demo.jpg" alt="demo">
</p>
* Demo视频:
- [wukong-robot + ChatGPT 实现支持流式对话的智能音箱(一分半钟)](https://www.bilibili.com/video/BV1Bh411g7t2)
- [粉丝向定制版,演示对话+音乐+开放API+智能家居(五分钟)](https://www.bilibili.com/video/av50685517/)
- [使用脑机唤醒 wukong-robot](https://www.bilibili.com/video/av76739580/)
- [Google AIY Voice Kit + wukong-robot](https://www.bilibili.com/video/av81173082/)
- [Siri 联动 wukong-robot + ChatGPT](https://www.bilibili.com/video/BV1yY4y1y7oW)
- [小爱同学联动 wukong-robot](https://www.bilibili.com/video/BV1eg4y1b75Y)
* 后台管理端 Demo
- 体验地址:https://bot.hahack.com (体验用户名:wukong;体验密码:wukong@2019)
## 环境要求 ##
### Python 版本 ###
wukong-robot 只支持 Python >= 3.7 且 < 3.10 ,不支持 Python 2.x 。
### 设备要求 ###
wukong-robot 支持运行在以下的设备和系统中:
* Intel Chip Mac (不支持 M1 芯片)
* 64bit Ubuntu(12.04 and 14.04)
* 全系列的树莓派(Raspbian 系统)
* Pine 64 with Debian Jessie 8.5(3.10.102)
* Intel Edison with Ubilinux (Debian Wheezy 7.8)
* 装有 WSL(Windows Subsystem for Linux) 的 Windows
## 安装 ##
见 [wukong-robot 安装教程](https://wukong.hahack.com/#/install) 。
## 升级
``` bash
python3 wukong.py update
```
如果提示升级失败,可以尝试在 wukong-robot 的根目录手动执行以下命令,看看问题出在哪。
``` sh
git pull
pip3 install -r requirements.txt
```
## 运行 ##
``` bash
python3 wukong.py
```
建议在 [tmux](http://blog.jobbole.com/87278/) 或 supervisor 中执行。
第一次启动时将提示你是否要到用户目录下创建一个配置文件,输入 `y` 即可。
然后通过唤醒词 “snowboy” 唤醒 wukong-robot 进行交互(该唤醒词可自定义)。
此外,wukong-robot 默认在运行期间还会启动一个后台管理端,提供了远程对话、查看修改配置、查看 log 等能力。
- 默认地址:http://localhost:5001
- 默认账户名:wukong
- 默认密码:wukong@2019
建议正式使用时修改用户名和密码,以免泄漏隐私。
## 配置 ##
参考[配置文件的注释](https://github.com/wzpan/wukong-robot/blob/master/static/default.yml)进行配置即可。注意不建议直接修改 default.yml 里的内容,否则会给后续通过 `git pull` 更新带来麻烦。你应该拷贝一份放到 `$HOME/.wukong/config.yml` 中,或者在运行的时候按照提示让 wukong-robot 为你完成这件事。
> tips:不论使用哪个厂商的API,都建议注册并填上自己注册的应用信息,而不要用默认的配置。这是因为这些API都有使用频率和并发数限制,过多人同时使用会影响服务质量。
## 技能插件 ##
* [官方插件列表](https://wukong.hahack.com/#/official)
* [用户贡献插件](https://wukong.hahack.com/#
野生的狒狒
- 粉丝: 3398
- 资源: 2437
最新资源
- 社交网络引流副业的简易实施策略及收益分析
- 西门子消防图层显示软件
- 基于Node.js和Express框架的租房系统房屋出租管理后端设计源码
- VideoSpeed_87621.zip
- 基于Typescript和CSS的八电极指标报告PDF设计源码
- 短视频游戏推广副业快速获利-通过快手小游戏合伙人计划轻松入行
- MATLAB仿真均匀光纤布拉格光栅 传输矩阵法 可以仿真得到其透射谱与反射谱
- 基于Vue框架的快递代取后台管理新版本设计源码
- Linux驱动开发环境Ubuntu,已经制作好网络文件系统和zImage内核,已经交叉编译好Qt5.6.2 1.安装好交叉编译工具链 2.制作好网络文件系统 3.已经编译好Linux内核源码树(版本
- 基于广西忻城红渡初中22班的HTML, JavaScript, CSS同学录设计源码
- MATLAB环境下一种时间序列信号的基线消除算法 算法运行环境为MATLAB r2018a 1.所有代码均经过运行测试,没有问题 2.前请仔细阅读作品简介,这非常重要,因为涉及到不同的编程语言
- 基于Mql5语言的MT5客户端直连期货公司CTP柜台的期货程序化交易软件设计源码
- containerd源码1.7.22 tag
- 基于Java语言的Swing游戏引擎设计源码
- MATLAB环境下一种基于粒子群优化算法神经网络非线性函数拟合方法 算法运行环境为MATLAB R2018a,执行基于粒子群优化算法神经网络非线性函数拟合,并与其他改进的粒子群算法进行对比,结果如下
- 图像处理实验、图像分割 1打开计算机,安装和启动MATLAB程序;程序组中“work”文件夹中应有待处理的图像文件; 2对于血细胞图像 a).对图像进行去噪、增强处理; b)运用
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈