# 集成开发指导

## 1 集成流程

<!-- <img src="../pic/image20.png" alt="集成流程" width="350" height="520"/> -->
![image20](../pic/image20.png)

## 2 Open SDK内容
<!-- | micrecord-sdk-release.aar | 麦克风阵列原始数据访问 | -->

| 包名 | 描述 |
| :-----| :---- |
| mini-outer-sdk.jar | OpenSDK的主要jar包 |
| phonecall-sdk-release.aar | 打电话相关 |
| protobuf-java-3.4.0.jar | protobuﬀer处理相关jar包 |
| eventbus-3.1.1.jar |事件处理相关 |

## 3 如何创建一个应用

### 3.1 创建一个通过语音触发的技能

通过悟空开放平台可以在悟空开发出通过语音触发的自定义技能，这种技能的开发分为三种：

1、叮当技能平台支持的技能类别。

2、叮当技能平台的自定义技能，配合自己开发的apk实现更多的功能。

3、叮当技能平台的自定义技能配合自己开发的云端技能服务以及apk实现更多的功能。

这里我们看一下怎么实现自己的apk来实现语音触发之后机器人的表现。

### 3.1.1   创建自己的应用工程

使用AndroidStudio,创建一个Android Application工程，并在AndroidManifest.xml中添加如下内容：

添加权限：

```xml
1 <uses-permission android:name="com.ubtrobot.master.permission.MASTER"/>
2 <uses-permission android:name="com.ubtrobot.master.permission.MASTER_SYSTEM_SERVICE"/>
```

### 3.1.2  集成Open SDK

自定义MyApp 实现自己的Application,在onCreate方法中加入SDKInit.initialize(this)，代码如下：

```java
public class MyApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        SDKInit.initialize(this);
    }

}
```

继承 ProxySkill 实现自己的 Skill ，示例代码如下：

```java
public class MySkillDemo extends ProxySkill {

    @Override
    protected String getSkillName() {
        return "InterruptSkillDemo";
    }

    @Override
    protected void onSkillStart() {
        super.onSkillStart();
    }

    @Call(path = "/demo_interruptible/startSkill")
    //自定义，最好唯一标识 需要和  xml/目录下的 <call path="/demo_mySkill/startSkill"> 这段一致
    //语音触发命中指定的意图后会调用这里
    public void doSameThing(Request request, Responder responder) {
        try {
            //这段是获取槽位参数和技能服务下发的透传参数，没有参数的话可不不需要这段代码
            TvsSkill.SkillParam skillParam = ProtoParam.from(request.getParam(), TvsSkill.SkillParam.class).getProtoMessage();
            List<TvsSkill.ParamPair> params = skillParam.getItemsList();
            String controlData = skillParam.getControlData();
            //params 可以获取到叮当上的槽位参数
            // controlData 可以读取自定义技能服务下发的透传参数
        } catch (ProtoParam.InvalidProtoParamException e) {
            e.printStackTrace();
        }
        responder.respondSuccess();

        //处理自己的事情
        //.........
        // 处理完自己的事情后需要结束技能，调用以下方法退出对应的技能
        stopSkill();
    }

    @Override
    public void onSkillStarted(SkillInfo skillInfo) {
        super.onSkillStarted(skillInfo);

    }

    @Override
    protected void onSkillStop(SkillStopCause skillStopCause) {
        //技能退出，包括主动退出和被打断等，需要处理业务停止和资源释放操作
    }

    @Override
    protected SkillType getSkillType() {
        return SkillType.Interruptible; //此处定义技能的类型,详情见：SkillType，目前支持：Interruptible、Uninterruptible 两种
    }

    @Override
    protected SkillType getSubSkillType() {
        return null;
    } //此处定义skill 子类别，可暂时返回null

    //拍头事件接收
    @Override
    protected boolean onHeadTapEvent(KeyEvent keyEvent) {
        return false;
    }
    
    //唤醒事件接收
    @Override
    protected void onWakeUpEvent(Speech.WakeupParam wakeupParam) {

    }

    //是否需要唤醒事件回调
    @Override
    protected boolean isNeedWakeUpEvent() {
        return false;
    }

    //是否需要拍头事件回调
    @Override
    protected boolean isNeedHeadTapEvent() {
        return false;
    }

}

```

接下来，需要在工程的res 目录下创建 xml 目录，在xml 目录下创建一个 xxx.xml 文件

![image-20200402170226163](..\pic\image-20200402170226163.png)

xml 文件的定义如下：

```xml
<?xml version="1.0" encoding="utf-8"?>
<skill name="demo_interruptible_skill"> <!--定义skill名称 自定义-->
    <call path="/demo_interruptible/startSkill"> <!--定义skill调用路径 与代码中 @Call(path = "/demo_interruptible/startSkill") 这个注解保持一致-->
        <intent-filter category="speech">  <!-- 定义可以语音触发的fliter 固定配置-->
            <utterance sentence="xxxxx" /> <!--填写叮当平台上定义的意图标识-->
        </intent-filter>
    </call>
</skill>
```

最后，需要在 AndroidManifest.xml 中声明我们定义的技能，示例代码如下：

```xml
        <service android:name=".MySkillDemo" android:exported="true"> <!-- 技能类名 -->
            <meta-data android:name="master.skill"  android:resource="@xml/demo_interruptible_skill" />  <!-- name 是固定值 “master.skill” resouce 填写 xml 目录下定义的xml文件-->
        </service>
```

### 3.1.3   为应用配置标签

为了使机器人能识别到第三方应用，需要开发的android应用在AndroidManifest.xml配置

 ```xml
1 <application ...>
2   <meta-data
3               android:name="ubt-master-app"
4               android:value="custom" />
5 </application>
 ```

## 4 如何连接机器人进行调试

机器人开发版我们开放了adb调试 调试功能，默认关闭，请下载手机APP，按如下步骤开启。

开启步骤：

1. 打开APP绑定机器人，且为机器人配置WI-FI；
2. 在机器人在线状态下，进入APP【我的】；
3. 选择“我的机器人“进入机器人设置；
4. 点击进入“关于机器人“，然后连续点击10次 “安卓系统版本，就会看到页面顶部提示：“打开开发者调试模式“

## 5 如何在机器人上运行自己的应用

### 5.1 语音指令触发的技能测试环境调试

当在悟空开放平台上配置完成了自定义技能信息后，在测试环境审核通过之后，即可以进行调试了，首先需要将机器人切换到测试环境，操作方式如下：

- 在电脑安装vysor软件，
- 将机器人通过USB线连接PC后，
- 再打开vysor。
- 找到”开发者中心“这个app,打开

![image-20200416161445774](..\pic\image-20200416161445774.png)

- 打开测试模式

  > 注意：在操作这个过程的时候，确保机器人已经联网了。

![image-20200416161732021](..\pic\image-20200416161732021.png)



- 用绑定的账号重新连接机器人

切换完成后，这时候唤醒他会提示“未绑定，请在app上绑定......”，这时候如果之前已经绑定过了，在app中将切换到该机器人即可，如果只绑定了一个机器人，可以退出app,重新打开app,连接机器人。

- 这时候直接将开发的app安装到机器人上，通过配置好的语音指令进行触发测试。

### 5.2 H5 触发技能联调

- 这时候直接将开发的app安装到机器人上
- 在手机端打开开发者测试界面
- 输入H5测试链接
- 可以进行操作

  

## 6 如何正式发布自己的应用

调试完成后，可以将对应的apk 和H5离线包提交到开放平台上，提交正式环境的审核，审核通过后，即可将对应的版本推送给特定的设备，完成应用的发布。