配网 SDK

更新时间：2019-07-23 21:21:22

概述

提供了把 WiFi 设备配置上家庭路由器以及局域网内已联网设备的发现能力，具体方案包括一键广播配网（P2P）、手机热点配网、蓝牙辅助配网、智能路由器配网以及设备间相互配网等。

初始化

配网SDK 的初始化依赖 身份认证 模块的初始化，请参见：身份认证 - 初始化 （包含API通道初始化和账号初始化）。

使用方式

本配网 SDK 对外主要提供设备发现，设备配网，以及获取设备端 token 的能力。

设备发现

提供局域网内发现已配网的设备，包括 WiFi 设备以及以太网设备，以及局域网内已上电的待配设备（前提是当前局域网内已经有一个已配好网的智能设备，且该设备具有发现待配网设备的能力）的能力。
关于设备发现相关 API，请参见：LocalDeviceMgr 。

启动设备发现

发现本地的已配网设备，或者零配、路由器发现的待配设备，或者符合adh{pk}{mac}格式的设备热点设备。发现的待配设备信息可以作为后续设备配网的入参信息。如果需要对已发现的已配网设备做过滤（如过滤已绑定的设备，不支持的设备等），可以参考产品过滤接口。

// 开始发现设备
// enumSet 是需要使用的防发现方式 EnumSet<DiscoveryType>, 请根据需要选择发现方式，并添加对应的依赖；
// 第三个参数是获取零配或智能路由器发现的待配设备 请求时需要携带的参数
LocalDeviceMgr.getInstance().startDiscovery(context, enumSet, null, new IDeviceDiscoveryListener() {
    @Override
    public void onDeviceFound(DiscoveryType discoveryType, List<DeviceInfo> list) {
        // 发现的设备
        // LOCAL_ONLINE_DEVICE 当前和手机在同一局域网已配网在线的设备
        // CLOUD_ENROLLEE_DEVICE 零配或智能路由器发现的待配设备
        // BLE_ENROLLEE_DEVICE 发现的是蓝牙设备，需要根据设备的productId查询设备是否是wifi+蓝牙双模设备
        // SOFT_AP_DEVICE 发现的设备热点
          // 注意：发现蓝牙设备需添加 breeze SDK依赖
    }
});

停止发现设备

停止发现本地已配和线上待配设备，调用该接口会清除已发现设备列表，确保与 startDiscovery 成对调用。

// 停止设备发现
LocalDeviceMgr.getInstance().stopDiscovery();

设备配网

关于设备配置添加相关 API 说明： AddDeviceBiz。

设置待配网设备信息

DeviceInfo deviceInfo = new DeviceInfo();
deviceInfo.productKey = "xx"; // 商家后台注册的 productKey，不可为空
deviceInfo.deviceName = "xxx";// 设备名, 可为空
deviceInfo.productId = "xxx";// 产品 ID， 蓝牙辅助配网必须
deviceInfo.id= "xxx";// 设备热点的id，在发现热点设备返回到APP的时候会带这个字段，设备热点必须
// 设备热点配网 ForceAliLinkTypeSoftAP  蓝牙辅助配网 ForceAliLinkTypeBLE
// 二维码配网 ForceAliLinkTypeQR   手机热点配网 ForceAliLinkTypePhoneAP
deviceInfo.linkType = "ForceAliLinkTypeNone"; // 默认一键配网  

//设置待添加设备的基本信息
AddDeviceBiz.getInstance().setDevice(DeviceInfo deviceinfo);

配网时，指定的配网方式 linkType，请参见 LinkType；
设备信息相关实体类，请参见 DeviceInfo。

开始设备配网

上述设置好待添加设备信息，进入配网。调用 startAddDevice 接口进入配网流程。如使用手机热点方式配网， linkType= "ForceAliLinkTypePhoneAP", 需要用户确保应用已具备了 WRITE_SETTINGS 权限，该权限需要 APP 动态申请。设备热点方式，需要申请位置权限。如果出现获取在某些高版本手机无法获取 WiFi SSID，需要申请位置权限，并打开 GPS。

// 开始添加设备
AddDeviceBiz.getInstance().startAddDevice(context， new IAddDeviceListener(){
    @Override
    public void onPreCheck(boolean b, DCErrorCode dcErrorCode) {
        // 参数检测回调 
    }

    @Override
    public void onProvisionPrepare(int prepareType) {
        // 手机热点配网、设备热点配网、一键配网、蓝牙辅助配网、二维码配网会走到该流程，
          // 零配和智能路由器配网不会走到该流程。
        // prepareType = 1提示用户输入账号密码
        // prepareType = 2提示用户手动开启指定热点 aha 12345678
        // 执行完上述操作之后，调用toggleProvision接口继续执行配网流程
    }

    @Override
    public void onProvisioning() {
        // 配网中
    }

    @Override 
    public void onProvisionStatus(ProvisionStatus provisionStatus) {
      // 二维码配网会走到这里  provisionStatus=ProvisionStatus.QR_PROVISION_READY表示二维码ready了
      // ProvisionStatus.QR_PROVISION_READY.message() 获取二维码内容
      // 注意：返回二维码时已开启监听设备是否已配网成功的通告，并开始计时，UI端应提示用户尽快扫码；
      // 如果在指定时间配网超时了，重新调用开始配网流程并刷新二维码；
    }

    @Override
    public void onProvisionedResult(boolean b, DeviceInfo deviceInfo, DCErrorCode errorCode) {
        // 配网结果 如果配网成功之后包含token，请使用配网成功带的token做绑定
    }
});

配网回调接口，请参见 IAddDeviceListener。

输入账号密码

在收到 onProvisionPrepare 回调后，引导用户输入 ssid 和 password ，并调用此方法传入 ssid、password、timeout 信息启动配网。 只有广播配网场景下，才会触发 onProvisionPrepare 回调。如果出现部分手机一直无法获取到 SSID，可以打开 GPS 再获取 SSID（部分手机需要开启 GPS 才能获取到）。

String ssid = "ssid";// 热点配网的时候注意 要先获取ssid，然后再开启热点，否则无法正确获取到SSID
String ssid = "xxxxxxxx";
int timeout = 60;//单位秒 目前最短只能设置60S
AddDeviceBiz.getInstance().toggleProvision(ssid, password, timeout);

停止配网

// 停止配网
AddDeviceBiz.getInstance().stopAddDevice();

设置配网模式

String linkType = "ForceAliLinkTypeBroadcast"; 
// 设置配网模式
AddDeviceBiz.getInstance().setAliProvisionMode(linkType);

混淆配置

-keep public class com.aliyun.alink.business.devicecenter.** {*;}

-keep public class com.aliyun.alink.linksdk.alcs.coap.**{*;}

更多功能

获取设备绑定 Token

设备绑定的时候除了需要 productKey、deviceName，还需要一个设备端的 token，该接口提供从设备端获取绑定 token 的功能。WiFi 设备或者以太网设备均可以使用该接口获取绑定需要的 Token。以太网设备需要先获取到设备的 productKey、deviceName，可以参考使用 startDiscovery 接口去获取。

// 获取设备绑定 token
LocalDeviceMgr.getInstance().getDeviceToken(context, productKey, deviceName, 60*1000, 5*1000， new IOnDeviceTokenGetListener() {
            @Override
            public void onSuccess(String token) {
                // TODO bind
            }

            @Override
            public void onFail(String reason) {
            }
        });

SDK 依赖

Maven仓库地址

// 阿里云仓库地址，包括了IOT事业部开发的SDK
maven {
    url "http://maven.aliyun.com/nexus/content/repositories/releases/"
}

Gradle 依赖

compile ('com.aliyun.alink.linksdk:ilop-devicecenter:1.6.3'){
    transitive = true
}

在插件中使用配网能力

如果需要在插件中使用配网能力，需要向 BoneMobile 容器中注册配网 API，请在插件加载前，调用如下注册代码：

BonePluginRegistry.register("BoneAddDeviceBiz",BoneAddDeviceBiz.class);
BonePluginRegistry.register("BoneLocalDeviceMgr",BoneLocalDeviceMgr.class);
BonePluginRegistry.register("BoneHotspotHelper",BoneHotspotHelper.class);