# 3. Android-SDK 使用指南

# 3.1 说明

MSmartSDK支持美的家电配网的精简版SDK，仅提供配网功能。设备绑定，控制等需要通过open cloud接入。

# 3.2 接入流程

操作步骤 （1）复制SDK的aar包到工程目录libs下。

（2）在build.gradle中增加下列配置

repositories {
   flatDir {
     dirs 'libs'
   }
 }
 dependencies {
   implementation(name: 'xxx.aar', ext: 'aar')
 }

备注：xxx 需要替换为对应的名称

（3）添加依赖库，build.gradle 中dependencies 段增加

implementation "com.google.code.gson:gson:2.8.0"
implementation 'androidx.annotation:annotation:1.0.0'
implementation 'com.madgag.spongycastle:core:1.54.0.0'
implementation 'com.madgag.spongycastle:prov:1.54.0.0'
implementation 'com.madgag.spongycastle:pkix:1.54.0.0'
implementation 'com.madgag.spongycastle:pg:1.54.0.0'

（4）权限申请，AndroidManifest.xml中增加权限

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.BROADCAST_STICKY"/>
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

（5）初始化相关：调用MSmartSDK的初始化方法初始化

MSInterface.getInstance().initSDK(Context context, WorkMode mode, MSConfig config)

示例：

MSConfig config = new MSConfig();
config.serverHost ="https://api-prod.smartmidea.net";
config.enableLog = true; //MSmartSDK日志开关
config.clientId="xxxxxx";
config.clientSecret="xxxxxx";
MSInterface.getInstance().initSDK(context, MSInterface.WorkMode.INLAND_OPEN, config);

示例参数说明：

workMode：开放平台采用INLAND_OPEN, MSInterface.WorkMode.INLAND_OPEN

config.serverHost：服务器地址

config.enableLog：是否开启log，调式时为true，发布时需要设置为false

config.clientId：客户端id，由云端分发

config.clientSecret：客户端秘钥，有云端分发

（6）设置AccessToken

MSInterface.getInstance().setAccessToken("accessToken");

示例参数说明：

a.第三方一般需要先通过第三方APP调用第三方服务器，第三方服务器再调用美的服务器获取令牌。

b.第三方APP获取到accessToken后再调用美的SDK的接口将accessToken设置到美的SDK。

（7）设置AccessToken刷新代理

MSInterface.getInstance().setTokenRefreshDelegate(new MSTokenRefresh() {
   @Override
   public boolean refreshToken() {
     //接入MSmartSDK的宿主App实现AccessToken的刷新
     ... ...
   
     //刷新后更新AccessToken
     MSInterface.getInstance().setAccessToken(accessToken);
     //刷新成功后返回true，否则返回false
     return true;
   }
 });

# 3.3 AP配网

示例：

MSDeviceApConfigParams params = new MSDeviceApConfigParams(Context context);
params.setDeviceSSID(deviceSSID);  //"midea_fd_0002"
params.setRouterBSSID(routerBSSID); //"00:9a:cd:8d:fe:0c"
params.setRouterSSID(routerSSID); //"APP_TEST2"
params.setRouterPassword(routerPassword); //"1234567890"
params.setRouterSecurityParams(routerSecurity); //"[WPA2-PSK-CCMP][RSN-PSK-CCMP][ESS][WPS]"
params.setFrequency(frequency);
params.setDeviceSecurityParams("WPA/PSK");
params.setDevicePassword("12345678");
params.setNeedCheckPassword(true);
params.setAdsId(adsid);
params.setRegionId(regionId);
params.setCountryChannelList(channels);
params.setTimeZone(timeZone);
params.setCountryCode(countryCode);
params.setFunctionType(functionType);
params.setModuleServerDomain(moduleDomain);
params.setModuleServerPort(modulePort);

MSDeviceConfigManager.getInstance().startConfigureDevice(params, MSDeviceConfigType.MSDeviceConfigAP, new MSProgressCallback<MSDevice, MSDeviceConfigStep>() {
    @Override
    public void onProgressUpdate(MSDeviceConfigStep deviceConfigStep) {
        LogUtils.i("配网进度:" +String.valueOf(deviceConfigStep));
    }

    @Override
    public void onComplete(MSDevice data) {
     LogUtils.i("配网成功:"+data);
     bindDevice(data.getDeviceID(),data.getVerificationCode(),data.getDeviceType(),data.getProtocolVersion());//配网成功，调用云端绑定接口
    }

    @Override
    public void onError(MSErrorMessage errMsg) {
        LogUtils.d("配网失败:"+errMsg.getErrorMessage());
    }
});

示例参数说明：

deviceSSID：设备启动热点时的AP热点SSID,扫描周边符合格式的wifi获取

routerBSSID：家庭路由的BSSID，系统属性获取

routerSSID：家庭路由的SSID，系统属性获取

routerPassword：家庭网络密码，用户手动填入

routerSecurity：家庭网络加密方式，系统属性获取

frequency：家庭网络频率，系统属性获取

adsid：网络接入网关id，（云云对接，从云端获取）

regionId：系统时区ID，获取当前时区代码从云端换区时区ID（1）

channels：信道列表，以用户当前国家向云端询问获取（信道列表代码）

timeZone：当前时区（MSTimeZone.EAST_8）

countryCode：国家代码（CN）

functionType：功能集 MSFunctionType.INTERNEL 或 MSFunctionType. OVERSEAS（国内：MSFunctionType.INTERNEL）

moduleDomain：模块端服务器地址（iotlab.midea.com.cn）

modulePort：模块端服务器端口（28443）

信道列表代码：

public static  MSCountryChannel[] getChannels(){
     MSCountryChannel[] channels = new  MSCountryChannel[4];
    channels[0] = new  MSCountryChannel((byte)1,(byte)13,(byte)27,false);
    channels[1] = new  MSCountryChannel((byte)36,(byte)4,(byte)23,false);
    channels[2] = new  MSCountryChannel((byte)52,(byte)4,(byte)23,true);
    channels[3] = new  MSCountryChannel((byte)149,(byte)5,(byte)27,false);
    return channels;
}

配网成功后调用：

SDK配网成功后回调返回：MideaDevice。其中MideaDevice:protocolVersion:设备协议版本号，deviceType：设备品类。此参数用于云端安全校验绑定，在绑定接口中为非必填参数。

需要先调通服务器的绑定接口，编写bindDevice(String deviceId,String verificationCode )方法或安全绑定接口bindDevice（String deviceId，String verficationCode,String deviceType,String protocolVersion）方法，详情可查询云端绑定接口。

备注：AP配网特殊错误处理方式：

第2步，第3步，第10步失败后，可以引导用户手动操作。用户手动操作完成后回到配网界面调用一次下面的方法，继续配网。

MSDeviceConfigManager.getInstance().resumeConfigureDevice()

# 3.4 BLE配网

扫描蓝牙设备

MSBLEDeviceManager.getInstance().startScan(type, timeOut, new MSBleScanCallback() {
    @Override
    public void onComplete(MSBleScanInfo data) {
       if(!isContain(data)){
          Map<String,MSBleScanInfo> map = new HashMap<>();
          map.put(data.getMac(),data);
          datas.add(map);
       }
       myAdapter.notifyDataSetChanged();
    }

    @Override
    public void onError(MSErrorMessage errMsg) {
    }

}

扫描参数说明：

type：扫描类型

MSBLEModuleType.ALL 所有蓝牙设备

MSBLEModuleType.MS MSmart协议蓝牙设备

MSBLEModuleType. MS_SingleModule MSmart协议单蓝牙设备

MSBLEModuleType. MS_SingleModule MSmart协议蓝牙+wifi设备

timeOut：扫描超时时间，单位：秒

返回说明： MSBleScanInfo：设备信息类 isConfigable():设备是否处于可配网状态，为true才能进入配网 isAuth():是否已经确权，已确权的设备不需要后确权（带WiFi的模式建议使用云云对接查询，纯蓝牙模组，可以根据这个判断设备是否需要进入后确权页面）

发起蓝牙配网

MSDeviceBleConfigParams params = new MSDeviceBleConfigParams();
params.setContext(context);
params.setMsBleScanInfo(msBleScanInfo);
params.setRouterSSID(routerSSID);
params.setRouterPassword(routerPassword);
params.setRouterSecurityParams(routerSecurity);
arams.setFrequency(frequency);
params.setDeviceSecurityParams("WPA/PSK");
params.setDevicePassword("12345678");
params.setNeedCheckPassword(true);
params.setAdsId(adsid);
params.setRegionId(regionId);
params.setCountryChannelList(channels);
params.setTimeZone(timeZone);
params.setCountryCode(countryCode);
params.setFunctionType(functionType);
params.setModuleServerDomain(moduleDomain);
params.setModuleServerPort(modulePort);

MSDeviceConfigManager.getInstance().startConfigureDevice(params, MSDeviceConfigType.MSDeviceBluetooth, new MSProgressCallback<MSDevice, MSDeviceConfigStep>() {
  @Override
  public void onProgressUpdate(MSDeviceConfigStep msDeviceConfigStep) {
     LogUtils.d("BleConfigActivity", msDeviceConfigStep.getStepName().name());
  }

  @Override
  public void onComplete(MSDevice data) {
     LogUtils.d("BleConfigActivity 配网成功", data.toString());
     bindDevice(data.getDeviceID(),data.getVerificationCode(),data.getDeviceType(),data.getProtocolVersion());//配网成功，调用云端绑定接口
  }

  @Override
  public void onError(MSErrorMessage errMsg) {
     LogUtils.d("BleConfigActivity 配网失败", errMsg.getErrorCode() + "//" + errMsg.getErrorMessage());
     Toast.makeText(BleConfigActivity.this,"配网失败"+errMsg.getErrorCode(),Toast.LENGTH_LONG).show();
  }
});

配网参数说明：

msBleScanInfo：配网对象，为上一步扫描结果中的一个