wukong-robot 代码结构

本文为我的 源代码阅读专栏 第一个工程的代码阅读——wukong-robot 一个优秀的开源智能音箱项目

代码结构

我把项目中重要的文件及文件夹列出来，后面再针对各文件/夹做进一步说明

├── docker
├── docs
├── LICENSE
├── plugins
│   ├── Camera.py
│   ├── CleanCache.py
│   ├── Echo.py
│   ├── Email.py
│   ├── Geek.py
│   ├── __init__.py
│   ├── LocalPlayer.py
│   ├── Poem.py
│   └── Volume.py
├── requirements.txt
├── robot
│   ├── AI.py
│   ├── ASR.py
│   ├── BCI.py
│   ├── Brain.py
│   ├── ConfigMonitor.py
│   ├── config.py
│   ├── constants.py
│   ├── Conversation.py
│   ├── drivers
│   ├── logging.py
│   ├── NLU.py
│   ├── Player.py
│   ├── plugin_loader.py
│   ├── sdk
│   ├── statistic.py
│   ├── TTS.py
│   ├── Updater.py
│   └── utils.py
├── server
├── snowboy
│   ├── resources
│   ├── snowboydecoder.py
│   └── snowboydetect.py
├── static
├── temp
├── tools
│   ├── make_json.py
│   ├── solr_api.py
│   └── solr_tools.py
├── venv
├── VERSION
└── wukong.py

docker 文件夹

wukong-robot项目的镜像生成文件

docs 文件夹

wukong-robot项目的文档文件

plugins 文件夹

wukong-robot项目相关插件。如摄像头、缓存清除、邮件、极客模式、播放器、音量等

requirements 文件

记录了wukong-robot项目运行相关依赖包

server 文件夹

wukong-robot项目后台网页服务代码

snowboy 文件夹

wukong-robot项目使用的snowboy热词唤醒功能

static 文件夹

wukong-robot项目使用的资源文件，如声音文件，配置文件等

tools 文件夹

可能会用到的工具。如文件格式转换、引擎切换等

wukong.py 文件

wukong-robot项目运行的入口文件

robot 文件夹

wukong-robot项目核心代码存放的文件夹。里面包含主要实现逻辑、封装的第三方开发包、及树莓派驱动。
封装的第三方开发包在sdk文件夹。包含阿里、百度、腾讯、讯飞等开发包的封装
树莓派驱动在drivers文件夹。包含spi led等驱动
主要实现逻辑有TTS、播放器、ASR、自升级、NLU、日志、配置加载、技能控制等

参考

考虑到项目源代码可能会被作者更新，致使代码与我的总结文档不一致，下面列表中会提供原始代码链接和冻结代码链接。冻结代码链到我自己fork的工程中，大家如果需要找原始源码，可以点击原始代码链接

• wukong-robot 原始代码
• wukong-robot 冻结代码（本文参考代码）