手把手教你编写叮当机器人插件

介绍如何给叮当机器人开发插件,实现天气问答功能,并发布到 dingdang-contrib 。

叮当 是一款可以工作在 Raspberry Pi 上的开源中文语音对话机器人/智能音箱项目,目的是让中国的Hacker们也能快速打造类似 Amazon Echo 的个性化的智能音箱。

由于叮当是完全开源的,编写插件来满足自己的个性化需求就成了使用叮当的最大乐趣。您可以自由地接入自己需要的服务,让叮当更好的为您服务。

这篇文章将一步步教你如何编写一个天气插件,并最终发布到 dingdang-contrib 中。

交互示例:

  • 用户:天气
  • 叮当:深圳天气。今天:晴。最高气温:25~30摄氏度;明天:晴。26~31摄氏度;后天:小雨。最高气温:23~29摄氏度。

准备工作

安装 dingdang-contrib

首先需要确保您已安装了叮当的第三方插件库 dingdang-contrib

cd /home/pi/.dingdang
git clone http://github.com/wzpan/dingdang-contrib contrib
pip install -r contrib/requirements.txt
sudo apt-get install sox  # 用于播放音乐
sudo apt-get install libsox-fmt-mp3 # 添加 sox 的 mp3 格式支持

接下来可以在这个插件库中开发您的插件。

了解天气 API

要实现天气预报功能,少不了要了解一下天气 API 。通过搜索,我找到了一款免费的天气 API —— 心知天气 。心知天气提供了天气、空气质量、生活指数等多种数据信息。其中逐日天气预报是免费的,可以利用来实现天气预报查询插件。

选择心知天气的另一个理由是他们的 API 文档非常详细,还提供了多种语言的 demo 1 1连 common-lisp 都有,点个赞!。下面是官方提供的一个 Python 版的示例:

import requests
from utils.const_value import API, KEY, UNIT, LANGUAGE
from utils.helper import getLocation
def fetchWeather(location):
    result = requests.get(API, params={
        'key': KEY,
        'location': location,
        'language': LANGUAGE,
        'unit': UNIT
    }, timeout=1)
    return result.text
if __name__ == '__main__':
    location = getLocation()
    result = fetchWeather(location)
    print(result)

其中,API 是 API 的地址,逐日天气预报的 API 地址是 https://api.seniverse.com/v3/weather/daily.jsonKEY则是心知天气的 API 密钥,每个注册账户都可以得到一个密钥;location 是城市名,例如深圳就是 深圳 或者 shenzhen;而 languageunit 分别表示语言和单位,由于是可选参数,这里不做详细介绍。有兴趣的朋友请阅读官方文档。

整段代码也没有什么特别好说的:先是定义了一个 fetchWeather 函数,该函数使用 requests 模块发起 API 请求,请求超时设置为 1 秒。之后调用这个函数并打印返回的结果。

编写天气插件

了解了心知天气的 API 后,编写插件就是一件水到渠成的事情了。

编写插件主要要考虑以下几个问题:

  • 插件应该使用哪些关键词作为用户指令?
  • 需要暴露哪些配置项?
  • 如何处理用户的输入并得到需要的信息?

下面我们将在编写这个插件的过程中解决这些问题。

新建插件文件

首先在 ~/.dingdang/contrib 中创建一个新的文件 Weather.py

# -*- coding: utf-8-*-                                                                                                                                                         # 天气插件
import sys
reload(sys)
sys.setdefaultencoding('utf8')
# Standard module stuff                                                                                                                                                     WORDS = []
SLUG = "SLUG"
def handle(text, mic, profile, wxbot=None):
    """
    Responds to user-input, typically speech text
    Arguments:
        text -- user-input, typically transcribed speech
        mic -- used to interact with the user (for both input and output)
        profile -- contains information related to the user (e.g., phone
        number)
        wxbot -- wechat bot instance
    """
    pass
def isValid(text):
    """
        Returns True if the input is related to weather.
        Arguments:
        text -- user-input, typically transcribed speech
    """
    pass

这个是插件的模板文件。一个标准的插件至少包含 WORDSSLUGisValid 函数和 handle 函数四个部分。下面将一一介绍。

关键词设置

WORDS 是一个关键词列表,用于存储这个插件的指令关键词(的拼音)。当 Active Listening 的 SST 引擎设置成离线引擎时,这里设置的关键词会被自动添加到 PocketSphinx 的语音指令集中,从而使得 PocketSphinx 能识别出这个指令。

WORDS 的另一个作用是作为是否插件的判断标准。如果 contrib 目录中的某个 .py 文件没有 WORDS 变量,那么这个文件就会被当成无效插件,而不会响应它。

与关键词有关的还有 isValid 函数,该函数用于判断用户输入的指令是否要用这个插件来处理。如果 isValid 返回结果为 truehandle 函数就会被调用,以处理指令。对于天气插件,关键词可以设置为天气,即只要包含“天气”的输入都使用本插件做处理。因此,可以将 WORDSisValid 函数改写成:

...
WORDS = ["TIANQI"]
...
def isValid(text):
    """
        Returns True if the input is related to weather.
        Arguments:
        text -- user-input, typically transcribed speech
    """
    return u"天气" in text

SLUG 设置

SLUG 是该插件的标识符,它主要用作在 profile.yml 中标识该插件的配置头。例如,对于天气插件,可以设置 SLUG 为 “weather”,

	
SLUG = 'weather'

那么在 profile.xml 中如果要添加天气插件的配置,就应该以 weather 字段开头添加配置信息:

eather:
   配置项1:值
   配置项2:值

每一个插件都有一个默认的可选配置项 enable,用来决定是否开启或关闭这个插件。默认值为 true ,即开启该插件。

handle 函数实现

接下来需要实现 handle() 函数。

def handle(text, mic, profile, wxbot=None):
    """
    Responds to user-input, typically speech text
    Arguments:
        text -- user-input, typically transcribed speech
        mic -- used to interact with the user (for both input and output)
        profile -- contains information related to the user (e.g., phone
        number)
        wxbot -- wechat bot instance
    """
    pass

这个函数接收四个参数:

  • text 是STT识别到的用户指令;
  • mic 是麦克风和喇叭模块,最常用的是通过调用 mic.say() 函数来让喇叭说话;
  • profile 是用户配置信息,它是一个字典,记录了 ~/.dingdang/profile.yml 的全部内容;
  • wxbot 是一个微信机器人实例,可以利用它给用户发送微信消息。Camera 插件提供了通过微信发送照片给用户的例子。

我们可以把心知的 Demo 给出的 fetchWeather 函数做一点调整,放进代码中方便复用:

def fetch_weather(api, key, location):
    result = requests.get(api, params={
    'key': key,
        'location': location
    }, timeout=3)
    res = json.loads(result.text, encoding='utf-8')
    return res

显然,KEYlocation 应该作为用户的配置项,允许用户在配置文件中进行设置。因此我们可以在 profile.yml 配置文件中添加如下配置:

# 天气
# 使用心知天气的接口
# https://www.seniverse.com/
weather:
    key: 'etxzx9abupxplhic' # 心知天气 API Key
    location: '深圳'

接下来在 handle 函数中调用 fetch_weather 函数,得到天气信息:

def handle(text, mic, profile, wxbot=None):
    """
    Responds to user-input, typically speech text
    Arguments:
        text -- user-input, typically transcribed speech
        mic -- used to interact with the user (for both input and output)
        profile -- contains information related to the user (e.g., phone
        number)
        wxbot -- wechat bot instance
    """
    logger = logging.getLogger(__name__)
    # get config                                                                                                                                                                   if 'weather' not in profile or \
       not profile[SLUG].has_key('key') or \
       not profile[SLUG].has_key('location'):
        mic.say('天气插件配置有误,插件使用失败')
        return
    key = profile[SLUG]['key']
    location = profile[SLUG]['location']
    WEATHER_API = 'https://api.seniverse.com/v3/weather/daily.json'
    try:
        weather = fetch_weather(WEATHER_API, key, location)
        logger.debug("Weather report: ", weather)
        if weather.has_key('results'):
            daily = weather['results'][0]['daily']
            day_text = [u'今天', u'明天', u'后天']
            responds = u'%s天气:' % location
            for day in range(len(day_text)):
                responds += u'%s:%s,%s到%s摄氏度。' % (day_text[day], daily[day]['text_day'], daily[day]['low'], daily[day]['high'])
            mic.say(responds)
        else:
            mic.say('抱歉,我获取不到天气数据,请稍后再试')
    except Exception, e:
        logger.error(e)
        mic.say('抱歉,我获取不到天气数据,请稍后再试')

完成后,可以重启下叮当,看看插件是否能正常工作。

发布插件

插件正常工作后,可以将该插件发布到 dingdang-contrib ,让更多人用上您的插件。

首先先访问 dingdang-contrib 的 Github 主页 ,点击右上角的 【fork】 按钮,将仓库 fork 到自己的账户。如果之前已经 fork 过,这一步可以跳过。

fork 完仓库后,在您的账户下也会有一个 dingdang-contrib 项目,点击绿色的 【Clone or download】 按钮,记下新的仓库的地址。

之后在树莓派中执行如下命令,添加新的仓库地址:

cd ~/.dingdang/contrib
git remote add mine 新的仓库地址

将新建的插件提交推送到您的 dingdang-contrib 仓库中:

git add Weather.py
git commit -m "新增天气插件"
git push -u mine master

完成后访问您的 dingdang-contrib 仓库主页,可以看到一个创建 pull request 的提示:

点击 【compare and pull request】 按钮,进入 pull request 创建页面,申请将您的改动合并到 dingdang-contrib 项目中:

在里头认真填写插件的用途、使用示例和配置项。完成后点击 【Create pull requset】 ,完成创建,等待 dingdang-robot 组织的审核。

一旦审核通过,您的插件就发布成功了。

为了让更多人了解您的插件的用途,还应该到 dingdang-contrib 的 Wiki 中添加该插件的用途。先在首页中增加一条插件记录:

完成后首页就增加了您创建的插件的记录:

点击该插件的链接,进入插件详情页创建页面,填入和刚刚创建 pull request 时相同的内容,即插件的用途、使用示例和配置项即可(也可以根据需求增加更多信息)。

原文发布于微信公众号 - HaHack(gh_12d2fe363c80)

原文发表时间:2017-05-29

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏张善友的专栏

MongoDB新版本特性

MongoDB 2.4已经发布,该版本增加了一些新特性,如文本搜索、基于哈希的分片、更好的地理空间功能、支持GeoJSON以及一些性能和工具方面的提升。我们还和...

2285
来自专栏Java架构师历程

WebBuilder —— Web 开发平台

WebBuilder是一款跨平台、数据库和浏览器的可视化Web应用开发平台,使用了多项最新的技术,使Web应用的开发更快捷和简单。

1.2K4
来自专栏顶级程序员

谈谈互联网后端基础设施

作者:飒然Hang 原文:www.rowkey.me/blog/2016/08/27/server-basic-tech-stack/ (点击文末阅读原文即可...

4356
来自专栏杨建荣的学习笔记

迁移式升级的一点思考 (r10笔记第27天)

目前有一个很实际的需求,因为硬件老化严重,需要能够借助一次维护时机把数据库迁移到一台较好配置的机器上,避免潜在的硬件故障导致的业务停顿,也算防患于未然吧。 本来...

2847
来自专栏ThoughtWorks

组件测试:改建遗留系统的起点 | 洞见

在遗留系统中工作,无论是开发新功能,还是对旧功能进行修改,抑或是通过重构以期重拾其往日的雄风,都会面临大量的挑战。这些挑战主要来自于流失的业务知识、失传的技术和...

1413
来自专栏微服务生态

五分钟了解一致性的分类及其理论

这种一致性级别是最符合用户直觉的,它要求系统写入什么,读出来的也会是什么,用户体验好,但实现起来往往对系统的性能影响大。

772
来自专栏杨建荣的学习笔记

防火墙开通的自动化尝试和感悟

对于一个从零到一的系统或者平台,你会有几十次几百次的调试,为的是能让系统/平台真正跑起来,用起来。我想这背后需要的坚持真是百般煎熬,一方面希望能够像建造...

1221
来自专栏大史住在大前端

一统江湖的大前端(3) DOClever——你的postman有点low

有了Mock服务器和Excel的文档说明后,相信大家的沟通效率会比以前提升很多,但仍然被沟通占据着绝大部分开发时间,常常遇到的情况会有:

2045
来自专栏大数据和云计算技术

阿里HBase的数据管道设施实践与演进

摘要:第九届中国数据库技术大会,阿里巴巴技术专家孟庆义对阿里HBase的数据管道设施实践与演进进行了讲解。主要从数据导入场景、 HBase Bulkload功能...

1872
来自专栏Java职业技术分享

不懂高性能的负载均衡设计?没关系,架构师带你飞

在软件系统的架构设计中,对集群的负载均衡设计是作为高性能系统优化环节中必不可少的方案。负载均衡本质上是用于将用户流量进行均衡减压的,因此在互联网的大流量项目中,...

992

扫码关注云+社区

领取腾讯云代金券