wukong-robot 相关插件

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

plugins相关插件介绍

plugins文件夹存放了一下相关插件，这些插件按功能分别放置不同的文件中。

• Camera。 拍照插件
• CleanCache。 清除缓存插件
• Echo。 通过网页传话插件
• Email。 查看收件箱插件
• Geek。 极客模式插件
• LocalPlayer。 沉浸式音乐播放插件
• Poem。 写诗插件
• Volume。 音量调整插件

这些插件均封装成了类，并且继承自抽象类AbstractPlugin。下面我先对AbstractPlugin进行分析，然后分别对各插件进行简单的解析

AbstractPlugin类

robot/sdk/AbstractPlugin类是作者为了统一插件调用接口而编写的抽象插件类。该抽象类提供了SLUG属性用以标识当前对象的具体插件功能，同时提供了以下抽象方法供子类进行个性化实现：

• isValid。插件子类判断是否适合自己处理
• isValidImmersive。插件子类判断是否适合在沉浸式音乐播放模式下处理
• handle。插件子类的主处理逻辑
• pause。暂停沉浸式音乐播放任务
• restore。恢复沉浸式音乐播放任务

AbstractPlugin类同时提供了一些方法供子类实现抽象方法时调用

• play。使用当前交互终端播放
• say。输出文本到当前交互终端
• activeListen。开始聆听
• clearImmersive。退出沉浸模式

各插件解析

Camera

使用时，拍照插件首先读取摄像头的配置信息，然后根据不同的配置信息调用不同的命令行命令进行抓拍。其中，usb摄像头使用的抓拍命令为fswebcam；树莓派专有摄像头使用的抓拍命令为raspistill

CleanCache

使用时，直接删除相应文件夹

Echo

使用时，将文本去掉echo和传话后输出到交互终端

Email

使用时，通过imaplib库连接邮件服务器，通过email库读取邮件信息

Geek

通过标志位幅值来实现极客模式的开启和关闭

LocalPlayer

通过解析句子的意图进行沉浸式音乐的控制。解析意图…看起来高科技的东西，后续再分享哈

插件的加载

从代码中可以发现，plugins中的各文件类名都是Plugin。那实际使用时如何加载呢？
wukong-robot使用robot/plugin_loader.py中的get_plugins方法来进行插件组的加载。具体代码上使用pkgutil库进行包的查找和加载，利用AbstractPlugin类的SLUG属性判断插件是否重复加载了

用到的技术点

• imaplib。实现了实际的IMAP4协议。用他获取收件箱内容的代码为：

import imaplib
conn = imaplib.IMAP4_SSL("imap.exmail.qq.com")  
conn.login('username','password')  
t=conn.select('INBOX')

• email。电子邮件包。可以对收到的邮件进行解析 msg = email.message_from_string(msg)，这样就可以得到主题、收件人等信息了
• pkgutil。包管理库。可以用来进行包的搜索和加载：

import pkgutil
for finder, name, ispkg in pkgutil.walk_packages(locations):
       loader = finder.find_module(name)
       mod = loader.load_module(name)

参考

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

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